Skip to content

Commit 8eb3e51

Browse files
author
Stephen Colebourne
committed
Modernize website in line with other components
git-svn-id: https://svn.apache.org/repos/asf/jakarta/commons/proper/codec/trunk@385934 13f79535-47bb-0310-9956-ffa450edef68
1 parent ee41bc3 commit 8eb3e51

5 files changed

Lines changed: 384 additions & 217 deletions

File tree

‎xdocs/cvs-usage.xml‎

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
<?xml version="1.0"?>
2+
<!--
3+
Copyright 2006 The Apache Software Foundation.
4+
5+
Licensed under the Apache License, Version 2.0 (the "License");
6+
you may not use this file except in compliance with the License.
7+
You may obtain a copy of the License at
8+
9+
http://www.apache.org/licenses/LICENSE-2.0
10+
11+
Unless required by applicable law or agreed to in writing, software
12+
distributed under the License is distributed on an "AS IS" BASIS,
13+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14+
See the License for the specific iouage governing permissions and
15+
limitations under the License.
16+
-->
17+
<document>
18+
<properties>
19+
<title>Source repository</title>
20+
<author email="commons-dev@jakarta.apache.org">Commons Documentation Team</author>
21+
</properties>
22+
<body>
23+
<!-- ================================================== -->
24+
<section name="Source repository">
25+
<p>
26+
Jakarta Commons Codec is hosted on the Apache
27+
<a href="http://subversion.tigris.org/">subversion</a> repository.
28+
</p>
29+
<p>
30+
The project URL is:<br />
31+
<code>http://svn.apache.org/repos/asf/jakarta/commons/proper/codec/trunk</code>
32+
</p>
33+
<p>
34+
The best way to view the repository is via the
35+
<a href="http://svn.apache.org/viewcvs.cgi/jakarta/commons/proper/codec/trunk/">subversion viewer</a>.
36+
</p>
37+
<p>
38+
The alternative is to use the
39+
<a href="http://svn.apache.org/repos/asf/jakarta/commons/proper/codec/trunk/">native subversion</a> display.
40+
</p>
41+
</section>
42+
<!-- ================================================== -->
43+
</body>
44+
</document>

‎xdocs/index.xml‎

Lines changed: 90 additions & 209 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
<?xml version="1.0"?>
22
<!--
3-
Copyright 2002-2005 The Apache Software Foundation.
3+
Copyright 2002-2006 The Apache Software Foundation.
44
55
Licensed under the Apache License, Version 2.0 (the "License");
66
you may not use this file except in compliance with the License.
@@ -14,216 +14,97 @@ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
1414
See the License for the specific language governing permissions and
1515
limitations under the License.
1616
-->
17-
1817
<document>
19-
2018
<properties>
21-
<title>Commons Codec</title>
22-
<author email="tobrien@apache.org">Tim O'Brien</author>
19+
<title>Home</title>
20+
<author email="commons-dev@jakarta.apache.org">Commons Documentation Team</author>
2321
</properties>
24-
25-
<body>
26-
27-
<section name="Commons Codec">
28-
29-
<p>
30-
Welcome. Commons Codec provides implementations of common
31-
encoders and decoders such as Base64, Hex, various phonetic
32-
encodings, and URLs.
33-
</p>
34-
35-
</section>
36-
37-
<section name="Impetus">
38-
<p>
39-
Codec was formed as an attempt to focus development effort on one
40-
definitive implementation of the Base64 encoder. At the time of
41-
Codec's proposal, there were approximately 34 different Java
42-
classes that dealt with Base64 encoding spread over the
43-
Foundation's CVS repository. Developers in the Jakarta Tomcat
44-
project had implemented an original version of the Base64 codec
45-
which had been copied by the Commons HttpClient and Apache XML
46-
project's XML-RPC subproject. After almost one year, the two
47-
forked versions of Base64 had significantly diverged from one
48-
another. XML-RPC had applied numerous fixes and patches which
49-
were not applied to the Commons HttpClient Base64. Different
50-
subprojects had differing implementations at various levels
51-
of compliance with the <a href="http://www.ietf.org/rfc/rfc2045.txt">
52-
RFC 2045</a>.
53-
</p>
54-
<p>
55-
Out of that confusing duplication of effort sprang this simple
56-
attempt to encourage code reuse among various projects. While
57-
this package contains a abstract framework for the creation of
58-
encoders and decoders, Codec itself is primarily focused on
59-
providing functional utilities for working with common encodings.
60-
</p>
61-
</section>
62-
63-
<section name="Releases">
64-
<ul>
65-
<li>Version 1.3 - 10 July 2004 (latest, from mirror)
66-
<a href="http://jakarta.apache.org/site/binindex.cgi">binary</a> and
67-
<a href="http://jakarta.apache.org/site/sourceindex.cgi">source</a>
68-
</li>
69-
<li>
70-
Version <a href="http://www.apache.org/dist/jakarta/commons/codec/">1.2</a> - 24 Nov 2003
71-
</li>
72-
<li>
73-
Version <a href="http://www.apache.org/dist/jakarta/commons/codec/">1.1</a> - 29 April 2003
74-
</li>
75-
<li>
76-
Current <a href="http://cvs.apache.org/builds/jakarta-commons/nightly/commons-codec/"> nightly build</a>
77-
</li>
78-
<li>
79-
All <a href="changes-report.html">Release Notes</a>
80-
</li>
81-
</ul>
82-
</section>
83-
84-
<section name="Components">
85-
86-
<p>
87-
Codec is currently comprised of a modest set of utilities and a
88-
simple framework for encoding and decoding both textual and binary data.
89-
</p>
90-
91-
<subsection name="Binary Encoders">
92-
<table>
93-
<tr>
94-
<td width="150">
95-
<a href="apidocs/org/apache/commons/codec/binary/Base64.html">
96-
Base64</a>
97-
</td>
98-
<td>
99-
Provides Base64 content-transfer-encoding as defined in
100-
<a href="http://www.ietf.org/rfc/rfc2045.txt">RFC 2045</a>. This
101-
encoder can optionally create 76 character chunked output
102-
for strict adherence to RFC 2045.
103-
</td>
104-
</tr>
105-
<tr>
106-
<td>
107-
<a href="apidocs/org/apache/commons/codec/binary/Hex.html">
108-
Hex</a>
109-
</td>
110-
<td>
111-
Converts an array of bytes into an array of characters representing the
112-
hexadecimal values of each byte in order
113-
</td>
114-
</tr>
115-
<tr>
116-
<td width="150">
117-
<a href="apidocs/org/apache/commons/codec/binary/BinaryCodec.html">
118-
BinaryCodec</a>
119-
</td>
120-
<td>
121-
Translates between byte arrays and strings of "0"s and "1"s.
122-
</td>
123-
</tr>
124-
</table>
125-
</subsection>
126-
127-
<subsection name="Language Encoders">
128-
<table>
129-
<tr>
130-
<td width="150">
131-
<a href="apidocs/org/apache/commons/codec/language/Soundex.html">
132-
Soundex</a>
133-
</td>
134-
<td>
135-
Implementation of the Soundex algorithm.
136-
</td>
137-
</tr>
138-
<tr>
139-
<td>
140-
<a href="apidocs/org/apache/commons/codec/language/Metaphone.html">
141-
Metaphone</a>
142-
</td>
143-
<td>
144-
Implementation of the Metaphone algorithm.
145-
</td>
146-
</tr>
147-
<tr>
148-
<td>
149-
<a href="apidocs/org/apache/commons/codec/language/RefinedSoundex.html">
150-
Refined Soundex</a>
151-
</td>
152-
<td>
153-
Alternative implementation of the Soundex algorithm.
154-
</td>
155-
</tr>
156-
<tr>
157-
<td>
158-
<a href="apidocs/org/apache/commons/codec/language/DoubleMetaphone.html">
159-
Double Metaphone</a>
160-
</td>
161-
<td>
162-
Alternative implementation of the Metaphone algorithm.
163-
</td>
164-
</tr>
165-
166-
</table>
167-
</subsection>
168-
169-
<subsection name="Digest Encoders">
170-
<table>
171-
<tr>
172-
<td width="150">
173-
<a href="apidocs/org/apache/commons/codec/digest/DigestUtils.html">
174-
DigestUtils</a>
175-
</td>
176-
<td>
177-
Provides simple static methods for creating a SHA or MD5 digest.
178-
</td>
179-
</tr>
180-
</table>
181-
</subsection>
182-
183-
<subsection name="Network Encoders">
184-
<table>
185-
<tr>
186-
<td width="150">
187-
<a href="apidocs/org/apache/commons/codec/net/URLCodec.html">
188-
URLCodec</a>
189-
</td>
190-
<td>
191-
Implements the <code>www-form-urlencoded</code> encoding scheme, also misleadingly known as URL encoding.
192-
</td>
193-
</tr>
194-
<tr>
195-
<td width="150">
196-
<a href="apidocs/org/apache/commons/codec/net/QuotedPrintableCodec.html">
197-
QuotedPrintableCodec</a>
198-
</td>
199-
<td>
200-
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
201-
</td>
202-
</tr>
203-
<tr>
204-
<td width="150">
205-
<a href="apidocs/org/apache/commons/codec/net/BCodec.html">
206-
BCodec</a>
207-
</td>
208-
<td>
209-
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.
210-
</td>
211-
</tr>
212-
<tr>
213-
<td width="150">
214-
<a href="apidocs/org/apache/commons/codec/net/QCodec.html">
215-
QCodec</a>
216-
</td>
217-
<td>
218-
Similar to the Quoted-Printable content-transfer-encoding defined in <a
219-
href="http://www.ietf.org/rfc/rfc1521.txt">RFC 1521</a> and designed to allow text containing mostly ASCII
220-
characters to be decipherable on an ASCII terminal without decoding.
221-
</td>
222-
</tr>
223-
</table>
224-
</subsection>
225-
226-
</section>
227-
22+
<body>
23+
<!-- ================================================== -->
24+
<section name="Commons Codec">
25+
<p>
26+
Commons Codec provides implementations of common encoders and decoders
27+
such as Base64, Hex, Phonetic and URLs.
28+
<!--ul>
29+
<li>Base64</li>
30+
<li>Hex</li>
31+
<li>Phonetic</li>
32+
<li>URL</li>
33+
</ul-->
34+
</p>
35+
</section>
36+
<!-- ================================================== -->
37+
<section name="Impetus">
38+
<p>
39+
Codec was formed as an attempt to focus development effort on one
40+
definitive implementation of the Base64 encoder. At the time of
41+
Codec's proposal, there were approximately 34 different Java
42+
classes that dealt with Base64 encoding spread over the
43+
Foundation's CVS repository. Developers in the Jakarta Tomcat
44+
project had implemented an original version of the Base64 codec
45+
which had been copied by the Commons HttpClient and Apache XML
46+
project's XML-RPC subproject. After almost one year, the two
47+
forked versions of Base64 had significantly diverged from one
48+
another. XML-RPC had applied numerous fixes and patches which
49+
were not applied to the Commons HttpClient Base64. Different
50+
subprojects had differing implementations at various levels
51+
of compliance with the <a href="http://www.ietf.org/rfc/rfc2045.txt">
52+
RFC 2045</a>.
53+
</p>
54+
<p>
55+
Out of that confusing duplication of effort sprang this simple
56+
attempt to encourage code reuse among various projects. While
57+
this package contains a abstract framework for the creation of
58+
encoders and decoders, Codec itself is primarily focused on
59+
providing functional utilities for working with common encodings.
60+
</p>
61+
</section>
62+
<!-- ================================================== -->
63+
<section name="Documentation">
64+
<p>
65+
An overview of the functionality is provided in the
66+
<a href="userguide.html">user guide</a>.
67+
Various <a href="maven-reports.html">project reports</a> are also available.
68+
</p>
69+
<p>
70+
The JavaDoc API documents are available online:
71+
</p>
72+
<ul>
73+
<li>The <a href="api-release/index.html">current release 1.3</a></li>
74+
<!--li>The <a href="api-1.1/index.html">previous version 1.1</a></li-->
75+
<li>The <a href="apidocs/index.html">latest SVN</a></li>
76+
</ul>
77+
<p>
78+
The <a href="cvs-usage.html">subversion repository</a> can be
79+
<a href="http://svn.apache.org/viewcvs.cgi/jakarta/commons/proper/codec/trunk/">browsed</a>.
80+
</p>
81+
</section>
82+
<!-- ================================================== -->
83+
<section name="Releases">
84+
<p>
85+
The latest version is v1.3. -
86+
<a href="http://jakarta.apache.org/site/downloads/downloads_commons-codec.cgi">Download now!</a><br />
87+
The <a href="changes-report.html">upgrade notes</a> are also available.
88+
</p>
89+
<p>
90+
For previous releases, see the <a href="http://archive.apache.org/dist/jakarta/commons/codec/">Apache Archive</a>
91+
</p>
92+
</section>
93+
<!-- ================================================== -->
94+
<section name="Support">
95+
<p>
96+
The <a href="mail-lists.html">commons mailing lists</a> act as the main support forum.
97+
The user list is suitable for most library usage queries.
98+
The dev list is intended for the development discussion.
99+
Please remember that the lists are shared between all commons components,
100+
so prefix your email by [codec].
101+
</p>
102+
<p>
103+
Issues may be reported via <a href="issue-tracking.html">ASF Bugzilla</a>.
104+
Please remember that Bugzilla is shared between all commons components,
105+
so prefix your issue by [codec].
106+
</p>
107+
</section>
108+
<!-- ================================================== -->
228109
</body>
229110
</document>

0 commit comments

Comments
 (0)