commons-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From scolebou...@apache.org
Subject svn commit: r385934 - in /jakarta/commons/proper/codec/trunk/xdocs: cvs-usage.xml index.xml issue-tracking.xml navigation.xml userguide.xml
Date Tue, 14 Mar 2006 23:59:45 GMT
Author: scolebourne
Date: Tue Mar 14 15:59:42 2006
New Revision: 385934

URL: http://svn.apache.org/viewcvs?rev=385934&view=rev
Log:
Modernize website in line with other components

Added:
    jakarta/commons/proper/codec/trunk/xdocs/cvs-usage.xml   (with props)
    jakarta/commons/proper/codec/trunk/xdocs/issue-tracking.xml   (with props)
    jakarta/commons/proper/codec/trunk/xdocs/userguide.xml   (with props)
Modified:
    jakarta/commons/proper/codec/trunk/xdocs/index.xml
    jakarta/commons/proper/codec/trunk/xdocs/navigation.xml

Added: jakarta/commons/proper/codec/trunk/xdocs/cvs-usage.xml
URL: http://svn.apache.org/viewcvs/jakarta/commons/proper/codec/trunk/xdocs/cvs-usage.xml?rev=385934&view=auto
==============================================================================
--- jakarta/commons/proper/codec/trunk/xdocs/cvs-usage.xml (added)
+++ jakarta/commons/proper/codec/trunk/xdocs/cvs-usage.xml Tue Mar 14 15:59:42 2006
@@ -0,0 +1,44 @@
+<?xml version="1.0"?>
+<!--
+Copyright 2006 The Apache Software Foundation.
+ 
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+     http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific iouage governing permissions and
+limitations under the License.
+-->
+<document>
+ <properties>
+  <title>Source repository</title>
+  <author email="commons-dev@jakarta.apache.org">Commons Documentation Team</author>
+ </properties>
+ <body>
+<!-- ================================================== -->
+<section name="Source repository">
+<p>
+  Jakarta Commons Codec is hosted on the Apache
+  <a href="http://subversion.tigris.org/">subversion</a> repository.
+</p>
+<p>
+  The project URL is:<br />
+  <code>http://svn.apache.org/repos/asf/jakarta/commons/proper/codec/trunk</code>
+</p>
+<p>
+  The best way to view the repository is via the
+  <a href="http://svn.apache.org/viewcvs.cgi/jakarta/commons/proper/codec/trunk/">subversion
viewer</a>.
+</p>
+<p>
+  The alternative is to use the
+  <a href="http://svn.apache.org/repos/asf/jakarta/commons/proper/codec/trunk/">native
subversion</a> display.
+</p>
+</section>
+<!-- ================================================== -->
+</body>
+</document>

Propchange: jakarta/commons/proper/codec/trunk/xdocs/cvs-usage.xml
------------------------------------------------------------------------------
    svn:eol-style = native

Modified: jakarta/commons/proper/codec/trunk/xdocs/index.xml
URL: http://svn.apache.org/viewcvs/jakarta/commons/proper/codec/trunk/xdocs/index.xml?rev=385934&r1=385933&r2=385934&view=diff
==============================================================================
--- jakarta/commons/proper/codec/trunk/xdocs/index.xml (original)
+++ jakarta/commons/proper/codec/trunk/xdocs/index.xml Tue Mar 14 15:59:42 2006
@@ -1,6 +1,6 @@
 <?xml version="1.0"?>
 <!--
-Copyright 2002-2005 The Apache Software Foundation.
+Copyright 2002-2006 The Apache Software Foundation.
  
 Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License.
@@ -14,216 +14,97 @@
 See the License for the specific language governing permissions and
 limitations under the License.
 -->
-
 <document>
-
  <properties>
-  <title>Commons Codec</title>
-  <author email="tobrien@apache.org">Tim O'Brien</author>
+  <title>Home</title>
+  <author email="commons-dev@jakarta.apache.org">Commons Documentation Team</author>
  </properties>
-
- <body>
-
-  <section name="Commons Codec">
-
-   <p>
-    Welcome.  Commons Codec provides implementations of common
-    encoders and decoders such as Base64, Hex, various phonetic
-    encodings, and URLs.
-   </p>
-
-  </section>
-
-  <section name="Impetus">
-   <p>
-     Codec was formed as an attempt to focus development effort on one
-     definitive implementation of the Base64 encoder.  At the time of
-     Codec's proposal, there were approximately 34 different Java
-     classes that dealt with Base64 encoding spread over the
-     Foundation's CVS repository.  Developers in the Jakarta Tomcat
-     project had implemented an original version of the Base64 codec
-     which had been copied by the Commons HttpClient and Apache XML
-     project's XML-RPC subproject.  After almost one year, the two
-     forked versions of Base64 had significantly diverged from one
-     another.  XML-RPC had applied numerous fixes and patches which
-     were not applied to the Commons HttpClient Base64.  Different 
-     subprojects had differing implementations at various levels
-     of compliance with the <a href="http://www.ietf.org/rfc/rfc2045.txt">
-     RFC 2045</a>.
-   </p>
-   <p>
-     Out of that confusing duplication of effort sprang this simple
-     attempt to encourage code reuse among various projects.  While
-     this package contains a abstract framework for the creation of
-     encoders and decoders, Codec itself is primarily focused on
-     providing functional utilities for working with common encodings.
-   </p>
-  </section>
-
-  <section name="Releases">
-   <ul>
-    <li>Version 1.3 - 10 July 2004 (latest, from mirror)
-	<a href="http://jakarta.apache.org/site/binindex.cgi">binary</a> and 
-	<a href="http://jakarta.apache.org/site/sourceindex.cgi">source</a>
-    </li>
-    <li>
-     Version <a href="http://www.apache.org/dist/jakarta/commons/codec/">1.2</a>
- 24 Nov 2003
-    </li>
-    <li>
-     Version <a href="http://www.apache.org/dist/jakarta/commons/codec/">1.1</a>
- 29 April 2003
-    </li>
-    <li>
-     Current <a href="http://cvs.apache.org/builds/jakarta-commons/nightly/commons-codec/">
nightly build</a>
-    </li>
-    <li>
-     All <a href="changes-report.html">Release Notes</a>
-    </li>
-   </ul>
-  </section>
-
-  <section name="Components">
-
-   <p>
- 	Codec is currently comprised of a modest set of utilities and a
- 	simple framework for encoding and decoding both textual and binary data.
-   </p>
-
-   <subsection name="Binary Encoders">
-   	<table>
-     <tr>
-      <td width="150">
-       <a href="apidocs/org/apache/commons/codec/binary/Base64.html">
-       	Base64</a>
-      </td>
-      <td>
-       Provides Base64 content-transfer-encoding as defined in 
-       <a href="http://www.ietf.org/rfc/rfc2045.txt">RFC 2045</a>. This
-       encoder can optionally create 76 character chunked output
-       for strict adherence to RFC 2045.
-      </td>
-     </tr>
-     <tr>
-      <td>
-       <a href="apidocs/org/apache/commons/codec/binary/Hex.html">
-       	Hex</a>
-      </td>
-      <td>
-       Converts an array of bytes into an array of characters representing the
-       hexadecimal values of each byte in order
-      </td>
-     </tr>
-     <tr>
-      <td width="150">
-       <a href="apidocs/org/apache/commons/codec/binary/BinaryCodec.html">
-       	BinaryCodec</a>
-      </td>
-      <td>
-       Translates between byte arrays and strings of "0"s and "1"s.
-      </td>
-     </tr>
-    </table>
-   </subsection>
-   
-   <subsection name="Language Encoders">
-    <table>
-     <tr>
-      <td width="150">
-       <a href="apidocs/org/apache/commons/codec/language/Soundex.html">
-       	Soundex</a>
-      </td>
-      <td>
-       Implementation of the Soundex algorithm.
-      </td>
-     </tr>
-     <tr>
-      <td>
-       <a href="apidocs/org/apache/commons/codec/language/Metaphone.html">
-       	Metaphone</a>
-      </td>
-      <td>
-       Implementation of the Metaphone algorithm.
-      </td>
-     </tr>
-     <tr>
-      <td>
-       <a href="apidocs/org/apache/commons/codec/language/RefinedSoundex.html">
-       	Refined Soundex</a>
-      </td>
-      <td>
-       Alternative implementation of the Soundex algorithm.
-      </td>
-     </tr>
-     <tr>
-      <td>
-       <a href="apidocs/org/apache/commons/codec/language/DoubleMetaphone.html">
-       	Double Metaphone</a>
-      </td>
-      <td>
-       Alternative implementation of the Metaphone algorithm.
-      </td>
-     </tr>
-
-    </table>
-   </subsection>
-
-   <subsection name="Digest Encoders">
-   	<table>
-     <tr>
-      <td width="150">
-       <a href="apidocs/org/apache/commons/codec/digest/DigestUtils.html">
-       	DigestUtils</a>
-      </td>
-      <td>
-        Provides simple static methods for creating a SHA or MD5 digest.
-      </td>
-     </tr>
-    </table>
-   </subsection>
-   
-   <subsection name="Network Encoders">
-   	<table>
-     <tr>
-      <td width="150">
-       <a href="apidocs/org/apache/commons/codec/net/URLCodec.html">
-       	URLCodec</a>
-      </td>
-      <td>
-        Implements the <code>www-form-urlencoded</code> encoding scheme, also
misleadingly known as URL encoding.
-      </td>
-     </tr>
-     <tr>
-      <td width="150">
-       <a href="apidocs/org/apache/commons/codec/net/QuotedPrintableCodec.html">
-       	QuotedPrintableCodec</a>
-      </td>
-      <td>
-         Codec for RFC 1521 MIME (Multipurpose Internet Mail Extensions) Part One. Rules
#3, #4, and #5 of the quoted-printable spec are not implemented yet
-      </td>
-     </tr>
-     <tr>
-      <td width="150">
-       <a href="apidocs/org/apache/commons/codec/net/BCodec.html">
-       	BCodec</a>
-      </td>
-      <td>
-         Identical to the Base64 encoding defined by <a href="http://www.ietf.org/rfc/rfc1521.txt">RFC
1521</a> and allows a character set to be specified.
-      </td>
-     </tr>
-     <tr>
-      <td width="150">
-       <a href="apidocs/org/apache/commons/codec/net/QCodec.html">
-       	QCodec</a>
-      </td>
-      <td>
-         Similar to the Quoted-Printable content-transfer-encoding defined in <a
-		 href="http://www.ietf.org/rfc/rfc1521.txt">RFC 1521</a> and designed to allow
text containing mostly ASCII
- 		characters to be decipherable on an ASCII terminal without decoding.
-      </td>
-     </tr>
-    </table>
-   </subsection>
-   
-  </section>
-
+<body>
+<!-- ================================================== -->
+<section name="Commons Codec">
+<p>
+Commons Codec provides implementations of common encoders and decoders
+such as Base64, Hex, Phonetic and URLs.
+<!--ul>
+<li>Base64</li>
+<li>Hex</li>
+<li>Phonetic</li>
+<li>URL</li>
+</ul-->
+</p>
+</section>
+<!-- ================================================== -->
+<section name="Impetus">
+<p>
+Codec was formed as an attempt to focus development effort on one
+definitive implementation of the Base64 encoder.  At the time of
+Codec's proposal, there were approximately 34 different Java
+classes that dealt with Base64 encoding spread over the
+Foundation's CVS repository.  Developers in the Jakarta Tomcat
+project had implemented an original version of the Base64 codec
+which had been copied by the Commons HttpClient and Apache XML
+project's XML-RPC subproject.  After almost one year, the two
+forked versions of Base64 had significantly diverged from one
+another.  XML-RPC had applied numerous fixes and patches which
+were not applied to the Commons HttpClient Base64.  Different 
+subprojects had differing implementations at various levels
+of compliance with the <a href="http://www.ietf.org/rfc/rfc2045.txt">
+RFC 2045</a>.
+</p>
+<p>
+Out of that confusing duplication of effort sprang this simple
+attempt to encourage code reuse among various projects.  While
+this package contains a abstract framework for the creation of
+encoders and decoders, Codec itself is primarily focused on
+providing functional utilities for working with common encodings.
+</p>
+</section>
+<!-- ================================================== -->
+<section name="Documentation">
+<p>
+An overview of the functionality is provided in the
+<a href="userguide.html">user guide</a>.
+Various <a href="maven-reports.html">project reports</a> are also available.
+</p>
+<p>
+The JavaDoc API documents are available online:
+</p>
+<ul>
+<li>The <a href="api-release/index.html">current release 1.3</a></li>
+<!--li>The <a href="api-1.1/index.html">previous version 1.1</a></li-->
+<li>The <a href="apidocs/index.html">latest SVN</a></li>
+</ul>
+<p>
+The <a href="cvs-usage.html">subversion repository</a> can be
+<a href="http://svn.apache.org/viewcvs.cgi/jakarta/commons/proper/codec/trunk/">browsed</a>.
+</p>
+</section>
+<!-- ================================================== -->
+<section name="Releases">
+<p>
+The latest version is v1.3. - 
+<a href="http://jakarta.apache.org/site/downloads/downloads_commons-codec.cgi">Download
now!</a><br />
+The <a href="changes-report.html">upgrade notes</a> are also available.
+</p>
+<p>
+For previous releases, see the <a href="http://archive.apache.org/dist/jakarta/commons/codec/">Apache
Archive</a>
+</p>
+</section>
+<!-- ================================================== -->
+<section name="Support">
+<p>
+The <a href="mail-lists.html">commons mailing lists</a> act as the main support
forum.
+The user list is suitable for most library usage queries.
+The dev list is intended for the development discussion.
+Please remember that the lists are shared between all commons components,
+so prefix your email by [codec].
+</p>
+<p>
+Issues may be reported via <a href="issue-tracking.html">ASF Bugzilla</a>.
+Please remember that Bugzilla is shared between all commons components,
+so prefix your issue by [codec].
+</p>
+</section>
+<!-- ================================================== -->
  </body>
 </document>

Added: jakarta/commons/proper/codec/trunk/xdocs/issue-tracking.xml
URL: http://svn.apache.org/viewcvs/jakarta/commons/proper/codec/trunk/xdocs/issue-tracking.xml?rev=385934&view=auto
==============================================================================
--- jakarta/commons/proper/codec/trunk/xdocs/issue-tracking.xml (added)
+++ jakarta/commons/proper/codec/trunk/xdocs/issue-tracking.xml Tue Mar 14 15:59:42 2006
@@ -0,0 +1,61 @@
+<?xml version="1.0"?>
+<!--
+Copyright 2006 The Apache Software Foundation.
+ 
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+     http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific iouage governing permissions and
+limitations under the License.
+-->
+<document>
+ <properties>
+  <title>Issue tracking</title>
+  <author email="commons-dev@jakarta.apache.org">Commons Documentation Team</author>
+ </properties>
+<body>
+<!-- ================================================== -->
+<section name="Issue tracking">
+<p>
+  Commons Codec uses <a href="http://issues.apache.org/bugzilla/">ASF Bugzilla</a>
for tracking issues.
+  To use Bugzilla you may need to <a href="http://issues.apache.org/bugzilla/createaccount.cgi">create
an account</a>.
+</p>
+<p>
+  If you would like to report a bug, or raise an enhancement request with
+  Commons Codec please do the following:
+  <ol>
+  <li><a href="http://issues.apache.org/bugzilla/buglist.cgi?bug_status=UNCONFIRMED&amp;bug_status=NEW&amp;bug_status=ASSIGNED&amp;bug_status=REOPENED&amp;bug_status=NEEDINFO&amp;product=Commons&amp;component=Codec">Search
existing open bugs</a>.
+  If you find your issue listed then please add a comment with your details.</li>
+  <li><a href="http://mail-archives.apache.org/mod_mbox/jakarta-commons-dev/">Search
the mailing list archive</a>.
+  You may find your issue or idea has already been discussed.</li>
+  <li><a href="http://issues.apache.org/bugzilla/enter_bug.cgi?product=Commons&amp;component=Codec&amp;version=1.3%20Final&amp;short_desc=%5Bcodec%5D%20%22Your%20subject%20heading%20here%22&amp;comment=Please%20provide%20details%20here.%20Its%20best%20to%20submit%20patches%20that%20alter%0D%0Aexisting%20file%20content%20in%20%22unified%20diff%22%20format.%20%0D%0A%0D%0ASubmissions%20that%20provide%20new%20files%20can%20be%20supplied%20as%20direct%20file%0D%0Aattachments%20or%20archives%20in%20zip%20or%20tar.gz%20format.%20please%20be%20kind%20%0D%0Aenough%20to%20identify%20the%20format%20of%20the%20attached%20archive%20as%20bugzilla%0D%0Atends%20to%20strip%20these%20characterstics%20by%20removing%20the%20files%20extension.">Submit
a bug report or enhancement request</a>.
+  Please prefix all new issues with [codec] in the summary line.
+  </li>
+  </ol>
+</p>
+<p>
+  Please also remember these points:
+  <ul>
+  <li>the more information you provide, the better we can help you</li>
+  <li>test cases are vital, particularly for any proposed enhancements</li>
+  <li>the developers of Commons Codec are all unpaid volunteers</li>
+  </ul>
+</p>
+<p>
+  You may also find these links useful:
+  <ul>
+  <li><a href="http://issues.apache.org/bugzilla/buglist.cgi?bug_status=UNCONFIRMED&amp;bug_status=NEW&amp;bug_status=ASSIGNED&amp;bug_status=REOPENED&amp;bug_status=NEEDINFO&amp;product=Commons&amp;component=Codec">All
Open Codec bugs</a></li>
+  <li><a href="http://issues.apache.org/bugzilla/buglist.cgi?bug_status=RESOLVED&amp;bug_status=VERIFIED&amp;bug_status=CLOSED&amp;product=Commons&amp;component=Codec">All
Closed Codec bugs</a></li>
+  <li><a href="http://issues.apache.org/bugzilla/buglist.cgi?bug_status=UNCONFIRMED&amp;bug_status=NEW&amp;bug_status=ASSIGNED&amp;bug_status=REOPENED&amp;bug_status=NEEDINFO&amp;bug_status=RESOLVED&amp;bug_status=VERIFIED&amp;bug_status=CLOSED&amp;product=Commons&amp;component=Codec">All
Codec bugs</a></li>
+  </ul>
+</p>
+</section>
+<!-- ================================================== -->
+</body>
+</document>

Propchange: jakarta/commons/proper/codec/trunk/xdocs/issue-tracking.xml
------------------------------------------------------------------------------
    svn:eol-style = native

Modified: jakarta/commons/proper/codec/trunk/xdocs/navigation.xml
URL: http://svn.apache.org/viewcvs/jakarta/commons/proper/codec/trunk/xdocs/navigation.xml?rev=385934&r1=385933&r2=385934&view=diff
==============================================================================
--- jakarta/commons/proper/codec/trunk/xdocs/navigation.xml (original)
+++ jakarta/commons/proper/codec/trunk/xdocs/navigation.xml Tue Mar 14 15:59:42 2006
@@ -1,6 +1,6 @@
 <?xml version="1.0" encoding="ISO-8859-1"?>
 <!--
-Copyright 2002-2005 The Apache Software Foundation.
+Copyright 2002-2006 The Apache Software Foundation.
  
 Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License.
@@ -18,21 +18,31 @@
 <project name="Codec">
 
   <title>Codec</title>
-  <organizationLogo href="/images/jakarta-logo-blue.gif">
-   Jakarta
-  </organizationLogo>
 
   <body>
     <links>
-      <item name="Jakarta Commons"                   
-            href="http://jakarta.apache.org/commons/"/>
+      <item name="Jakarta Commons" href="http://jakarta.apache.org/commons/"/>
     </links>
 
     <menu name="Commons Codec">
       <item name="Overview" href="/index.html"/>
-      <item name="Release Notes" href="/changes-report.html"/>          
+      <item name="Download" href="http://jakarta.apache.org/site/downloads/downloads_commons-codec.cgi"/>
+      <item name="Users guide" href="/userguide.html"/>
+      <item name="Javadoc (1.3 release)" href="api-release/index.html"/>
     </menu>
-    
+
+    <menu name="Development">
+	  <!-- remove release notes when building.html added -->
+      <item name="Release notes" href="/changes-report.html"/>          
+      <!--item name="Building" href="/building.html"/-->
+      <item name="Mailing lists" href="/mail-lists.html"/>
+      <item name="Team" href="/team-list.html"/>
+      <!--item name="Tasks" href="/tasks.html"/-->
+      <item name="Proposal" href="/proposal.html"/>
+      <item name="SVN repository" href="http://svn.apache.org/viewcvs.cgi/jakarta/commons/proper/codec/trunk/"/>
+      <item name="Javadoc (SVN latest)" href="apidocs/index.html"/>
+    </menu>
+
     &commons;
 
   </body>

Added: jakarta/commons/proper/codec/trunk/xdocs/userguide.xml
URL: http://svn.apache.org/viewcvs/jakarta/commons/proper/codec/trunk/xdocs/userguide.xml?rev=385934&view=auto
==============================================================================
--- jakarta/commons/proper/codec/trunk/xdocs/userguide.xml (added)
+++ jakarta/commons/proper/codec/trunk/xdocs/userguide.xml Tue Mar 14 15:59:42 2006
@@ -0,0 +1,171 @@
+<?xml version="1.0" encoding="ISO-8859-1"?>
+ <!--
+   Copyright 2006 The Apache Software Foundation
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.
+  -->
+
+<document>
+
+ <properties>
+  <title>Commons Codec - User guide</title>
+  <author email="commons-dev@jakarta.apache.org">Commons Documentation Team</author>
+ </properties>
+
+ <body>
+<!-- ================================================== -->
+<section name="User guide">
+   <p>
+ 	Codec is comprised of a modest set of utilities and a
+ 	simple framework for encoding and decoding both textual and binary data.
+   </p>
+
+   <subsection name="Binary Encoders">
+   	<table>
+     <tr>
+      <td width="150">
+       <a href="apidocs/org/apache/commons/codec/binary/Base64.html">
+       	Base64</a>
+      </td>
+      <td>
+       Provides Base64 content-transfer-encoding as defined in 
+       <a href="http://www.ietf.org/rfc/rfc2045.txt">RFC 2045</a>. This
+       encoder can optionally create 76 character chunked output
+       for strict adherence to RFC 2045.
+      </td>
+     </tr>
+     <tr>
+      <td>
+       <a href="apidocs/org/apache/commons/codec/binary/Hex.html">
+       	Hex</a>
+      </td>
+      <td>
+       Converts an array of bytes into an array of characters representing the
+       hexadecimal values of each byte in order
+      </td>
+     </tr>
+     <tr>
+      <td width="150">
+       <a href="apidocs/org/apache/commons/codec/binary/BinaryCodec.html">
+       	BinaryCodec</a>
+      </td>
+      <td>
+       Translates between byte arrays and strings of "0"s and "1"s.
+      </td>
+     </tr>
+    </table>
+   </subsection>
+   
+   <subsection name="Language Encoders">
+    <table>
+     <tr>
+      <td width="150">
+       <a href="apidocs/org/apache/commons/codec/language/Soundex.html">
+       	Soundex</a>
+      </td>
+      <td>
+       Implementation of the Soundex algorithm.
+      </td>
+     </tr>
+     <tr>
+      <td>
+       <a href="apidocs/org/apache/commons/codec/language/Metaphone.html">
+       	Metaphone</a>
+      </td>
+      <td>
+       Implementation of the Metaphone algorithm.
+      </td>
+     </tr>
+     <tr>
+      <td>
+       <a href="apidocs/org/apache/commons/codec/language/RefinedSoundex.html">
+       	Refined Soundex</a>
+      </td>
+      <td>
+       Alternative implementation of the Soundex algorithm.
+      </td>
+     </tr>
+     <tr>
+      <td>
+       <a href="apidocs/org/apache/commons/codec/language/DoubleMetaphone.html">
+       	Double Metaphone</a>
+      </td>
+      <td>
+       Alternative implementation of the Metaphone algorithm.
+      </td>
+     </tr>
+
+    </table>
+   </subsection>
+
+   <subsection name="Digest Encoders">
+   	<table>
+     <tr>
+      <td width="150">
+       <a href="apidocs/org/apache/commons/codec/digest/DigestUtils.html">
+       	DigestUtils</a>
+      </td>
+      <td>
+        Provides simple static methods for creating a SHA or MD5 digest.
+      </td>
+     </tr>
+    </table>
+   </subsection>
+   
+   <subsection name="Network Encoders">
+   	<table>
+     <tr>
+      <td width="150">
+       <a href="apidocs/org/apache/commons/codec/net/URLCodec.html">
+       	URLCodec</a>
+      </td>
+      <td>
+        Implements the <code>www-form-urlencoded</code> encoding scheme, also
misleadingly known as URL encoding.
+      </td>
+     </tr>
+     <tr>
+      <td width="150">
+       <a href="apidocs/org/apache/commons/codec/net/QuotedPrintableCodec.html">
+       	QuotedPrintableCodec</a>
+      </td>
+      <td>
+         Codec for RFC 1521 MIME (Multipurpose Internet Mail Extensions) Part One. Rules
#3, #4, and #5 of the quoted-printable spec are not implemented yet
+      </td>
+     </tr>
+     <tr>
+      <td width="150">
+       <a href="apidocs/org/apache/commons/codec/net/BCodec.html">
+       	BCodec</a>
+      </td>
+      <td>
+         Identical to the Base64 encoding defined by <a href="http://www.ietf.org/rfc/rfc1521.txt">RFC
1521</a> and allows a character set to be specified.
+      </td>
+     </tr>
+     <tr>
+      <td width="150">
+       <a href="apidocs/org/apache/commons/codec/net/QCodec.html">
+       	QCodec</a>
+      </td>
+      <td>
+         Similar to the Quoted-Printable content-transfer-encoding defined in <a
+		 href="http://www.ietf.org/rfc/rfc1521.txt">RFC 1521</a> and designed to allow
text containing mostly ASCII
+ 		characters to be decipherable on an ASCII terminal without decoding.
+      </td>
+     </tr>
+    </table>
+   </subsection>
+   
+</section>
+<!-- ================================================== -->
+</body>
+</document>

Propchange: jakarta/commons/proper/codec/trunk/xdocs/userguide.xml
------------------------------------------------------------------------------
    svn:eol-style = native



---------------------------------------------------------------------
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