Skip to content

Commit 6143f57

Browse files
garydgregorygarydgregory
committed
Format (2 spaces seems to be the standard...)
git-svn-id: https://svn.apache.org/repos/asf/commons/proper/codec/trunk@1080864 13f79535-47bb-0310-9956-ffa450edef68
1 parent a4a1ac3 commit 6143f57

1 file changed

Lines changed: 167 additions & 172 deletions

File tree

‎src/site/xdoc/userguide.xml‎

Lines changed: 167 additions & 172 deletions
Original file line numberDiff line numberDiff line change
@@ -1,174 +1,169 @@
11
<?xml version="1.0" encoding="ISO-8859-1"?>
2-
<!--
3-
Licensed to the Apache Software Foundation (ASF) under one or more
4-
contributor license agreements. See the NOTICE file distributed with
5-
this work for additional information regarding copyright ownership.
6-
The ASF licenses this file to You under the Apache License, Version 2.0
7-
(the "License"); you may not use this file except in compliance with
8-
the License. You may obtain a copy of the License at
9-
10-
http://www.apache.org/licenses/LICENSE-2.0
11-
12-
Unless required by applicable law or agreed to in writing, software
13-
distributed under the License is distributed on an "AS IS" BASIS,
14-
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15-
See the License for the specific language governing permissions and
16-
limitations under the License.
17-
-->
18-
2+
<!-- Licensed to the Apache Software Foundation (ASF) under one or more contributor
3+
license agreements. See the NOTICE file distributed with this work for additional
4+
information regarding copyright ownership. The ASF licenses this file to
5+
You under the Apache License, Version 2.0 (the "License"); you may not use
6+
this file except in compliance with the License. You may obtain a copy of
7+
the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required
8+
by applicable law or agreed to in writing, software distributed under the
9+
License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS
10+
OF ANY KIND, either express or implied. See the License for the specific
11+
language governing permissions and limitations under the License. -->
1912
<document>
20-
21-
<properties>
22-
<title>Commons Codec - User guide</title>
23-
<author email="dev@commons.apache.org">Commons Documentation Team</author>
24-
</properties>
25-
26-
<body>
27-
<!-- ================================================== -->
28-
<section name="User guide">
29-
<p>
30-
Codec is comprised of a set of utilities and a
31-
simple framework for encoding and decoding text and binary data.
32-
</p>
33-
34-
<subsection name="Binary Encoders">
35-
<p>Interfaces and classes used by the various implementations in the sub-packages.
36-
</p>
37-
<table>
38-
<tr>
39-
<td width="150">
40-
<a href="apidocs/org/apache/commons/codec/binary/Base64.html">
41-
Base64</a>
42-
</td>
43-
<td>
44-
Provides Base64 encoding and decoding as defined by
45-
<a href="http://www.ietf.org/rfc/rfc2045.txt">RFC 2045</a>. This
46-
encoder can optionally create 76 character chunked output
47-
for strict adherence to RFC 2045.
48-
</td>
49-
</tr>
50-
<tr>
51-
<td>
52-
<a href="apidocs/org/apache/commons/codec/binary/Hex.html">
53-
Hex</a>
54-
</td>
55-
<td>
56-
Converts an array of bytes into an array of characters representing the
57-
hexadecimal values of each byte in order
58-
</td>
59-
</tr>
60-
<tr>
61-
<td width="150">
62-
<a href="apidocs/org/apache/commons/codec/binary/BinaryCodec.html">
63-
BinaryCodec</a>
64-
</td>
65-
<td>
66-
Translates between byte arrays and strings of "0"s and "1"s.
67-
</td>
68-
</tr>
69-
</table>
70-
</subsection>
71-
72-
<subsection name="Language Encoders">
73-
<table>
74-
<tr>
75-
<td width="150">
76-
<a href="apidocs/org/apache/commons/codec/language/Soundex.html">
77-
Soundex</a>
78-
</td>
79-
<td>
80-
Implementation of the Soundex algorithm.
81-
</td>
82-
</tr>
83-
<tr>
84-
<td>
85-
<a href="apidocs/org/apache/commons/codec/language/Metaphone.html">
86-
Metaphone</a>
87-
</td>
88-
<td>
89-
Implementation of the Metaphone algorithm.
90-
</td>
91-
</tr>
92-
<tr>
93-
<td>
94-
<a href="apidocs/org/apache/commons/codec/language/RefinedSoundex.html">
95-
Refined Soundex</a>
96-
</td>
97-
<td>
98-
Alternative implementation of the Soundex algorithm.
99-
</td>
100-
</tr>
101-
<tr>
102-
<td>
103-
<a href="apidocs/org/apache/commons/codec/language/DoubleMetaphone.html">
104-
Double Metaphone</a>
105-
</td>
106-
<td>
107-
Alternative implementation of the Metaphone algorithm.
108-
</td>
109-
</tr>
110-
111-
</table>
112-
</subsection>
113-
114-
<subsection name="Digest Encoders">
115-
<table>
116-
<tr>
117-
<td width="150">
118-
<a href="apidocs/org/apache/commons/codec/digest/DigestUtils.html">
119-
DigestUtils</a>
120-
</td>
121-
<td>
122-
Provides simple static methods for creating a SHA or MD5 digest.
123-
</td>
124-
</tr>
125-
</table>
126-
</subsection>
127-
128-
<subsection name="Network Encoders">
129-
<table>
130-
<tr>
131-
<td width="150">
132-
<a href="apidocs/org/apache/commons/codec/net/URLCodec.html">
133-
URLCodec</a>
134-
</td>
135-
<td>
136-
Implements the <code>www-form-urlencoded</code> encoding scheme, also misleadingly known as URL encoding.
137-
</td>
138-
</tr>
139-
<tr>
140-
<td width="150">
141-
<a href="apidocs/org/apache/commons/codec/net/QuotedPrintableCodec.html">
142-
QuotedPrintableCodec</a>
143-
</td>
144-
<td>
145-
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
146-
</td>
147-
</tr>
148-
<tr>
149-
<td width="150">
150-
<a href="apidocs/org/apache/commons/codec/net/BCodec.html">
151-
BCodec</a>
152-
</td>
153-
<td>
154-
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.
155-
</td>
156-
</tr>
157-
<tr>
158-
<td width="150">
159-
<a href="apidocs/org/apache/commons/codec/net/QCodec.html">
160-
QCodec</a>
161-
</td>
162-
<td>
163-
Similar to the Quoted-Printable content-transfer-encoding defined in <a
164-
href="http://www.ietf.org/rfc/rfc1521.txt">RFC 1521</a> and designed to allow text containing mostly ASCII
165-
characters to be decipherable on an ASCII terminal without decoding.
166-
</td>
167-
</tr>
168-
</table>
169-
</subsection>
170-
171-
</section>
172-
<!-- ================================================== -->
173-
</body>
174-
</document>
13+
<properties>
14+
<title>Commons Codec - User guide</title>
15+
<author email="dev@commons.apache.org">Commons Documentation Team</author>
16+
</properties>
17+
<body>
18+
<!-- ================================================== -->
19+
<section name="User guide">
20+
<p> Codec is comprised of a set of utilities and a simple
21+
framework for encoding and decoding text and binary data.
22+
</p>
23+
<subsection name="Binary Encoders">
24+
<p>Interfaces and classes used by the various implementations in
25+
the sub-packages.
26+
</p>
27+
<table>
28+
<tr>
29+
<td width="150">
30+
<a href="apidocs/org/apache/commons/codec/binary/Base64.html"> Base64
31+
</a>
32+
</td>
33+
<td>
34+
Provides Base64 encoding and decoding as defined by
35+
<a href="http://www.ietf.org/rfc/rfc2045.txt">RFC 2045</a>
36+
. This encoder can optionally create 76 character chunked
37+
output for strict adherence to RFC 2045.
38+
</td>
39+
</tr>
40+
<tr>
41+
<td>
42+
<a href="apidocs/org/apache/commons/codec/binary/Hex.html"> Hex
43+
</a>
44+
</td>
45+
<td> Converts an array of bytes into an array of characters
46+
representing the hexadecimal values of each byte in order
47+
</td>
48+
</tr>
49+
<tr>
50+
<td width="150">
51+
<a
52+
href="apidocs/org/apache/commons/codec/binary/BinaryCodec.html"> BinaryCodec
53+
</a>
54+
</td>
55+
<td> Translates between byte arrays and strings of "0"s and
56+
"1"s.
57+
</td>
58+
</tr>
59+
</table>
60+
</subsection>
61+
<subsection name="Language Encoders">
62+
<table>
63+
<tr>
64+
<td width="150">
65+
<a
66+
href="apidocs/org/apache/commons/codec/language/Soundex.html"> Soundex
67+
</a>
68+
</td>
69+
<td> Implementation of the Soundex algorithm.
70+
</td>
71+
</tr>
72+
<tr>
73+
<td>
74+
<a
75+
href="apidocs/org/apache/commons/codec/language/Metaphone.html"> Metaphone
76+
</a>
77+
</td>
78+
<td> Implementation of the Metaphone algorithm.
79+
</td>
80+
</tr>
81+
<tr>
82+
<td>
83+
<a
84+
href="apidocs/org/apache/commons/codec/language/RefinedSoundex.html"> Refined Soundex
85+
</a>
86+
</td>
87+
<td> Alternative implementation of the Soundex algorithm.
88+
</td>
89+
</tr>
90+
<tr>
91+
<td>
92+
<a
93+
href="apidocs/org/apache/commons/codec/language/DoubleMetaphone.html"> Double Metaphone
94+
</a>
95+
</td>
96+
<td> Alternative implementation of the Metaphone algorithm.
97+
</td>
98+
</tr>
99+
</table>
100+
</subsection>
101+
<subsection name="Digest Encoders">
102+
<table>
103+
<tr>
104+
<td width="150">
105+
<a
106+
href="apidocs/org/apache/commons/codec/digest/DigestUtils.html"> DigestUtils
107+
</a>
108+
</td>
109+
<td> Provides simple static methods for creating a SHA or
110+
MD5 digest.
111+
</td>
112+
</tr>
113+
</table>
114+
</subsection>
115+
<subsection name="Network Encoders">
116+
<table>
117+
<tr>
118+
<td width="150">
119+
<a href="apidocs/org/apache/commons/codec/net/URLCodec.html"> URLCodec
120+
</a>
121+
</td>
122+
<td>
123+
Implements the
124+
<code>www-form-urlencoded</code>
125+
encoding scheme, also misleadingly known as URL encoding.
126+
</td>
127+
</tr>
128+
<tr>
129+
<td width="150">
130+
<a
131+
href="apidocs/org/apache/commons/codec/net/QuotedPrintableCodec.html"> QuotedPrintableCodec
132+
</a>
133+
</td>
134+
<td> Codec for RFC 1521 MIME (Multipurpose Internet Mail
135+
Extensions) Part One. Rules #3, #4, and #5 of the
136+
quoted-printable spec are not implemented yet
137+
</td>
138+
</tr>
139+
<tr>
140+
<td width="150">
141+
<a href="apidocs/org/apache/commons/codec/net/BCodec.html"> BCodec
142+
</a>
143+
</td>
144+
<td>
145+
Identical to the Base64 encoding defined by
146+
<a href="http://www.ietf.org/rfc/rfc1521.txt">RFC 1521</a>
147+
and allows a character set to be specified.
148+
</td>
149+
</tr>
150+
<tr>
151+
<td width="150">
152+
<a href="apidocs/org/apache/commons/codec/net/QCodec.html"> QCodec
153+
</a>
154+
</td>
155+
<td>
156+
Similar to the Quoted-Printable content-transfer-encoding
157+
defined in
158+
<a href="http://www.ietf.org/rfc/rfc1521.txt">RFC 1521</a>
159+
and designed to allow text containing mostly ASCII
160+
characters to be decipherable on an ASCII terminal without
161+
decoding.
162+
</td>
163+
</tr>
164+
</table>
165+
</subsection>
166+
</section>
167+
<!-- ================================================== -->
168+
</body>
169+
</document>

0 commit comments

Comments
 (0)