scuffed-code/icu4j/readme.html
John Fitzpatrick 421d0b9673 Initial checkin
X-SVN-Rev: 956
2000-03-15 21:37:48 +00:00

709 lines
26 KiB
HTML
Raw Blame History

<!doctype html public "-//w3c//dtd html 4.0 transitional//en">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
<meta name="ProgId" content="Word.Document">
<meta name="Generator" content="Microsoft Word 9">
<meta name="Originator" content="Microsoft Word 9">
<meta name="Template" content="F:\Program Files\Microsoft Office\Office\html.dot">
<meta name="GENERATOR" content="Mozilla/4.72 [en] (WinNT; U) [Netscape]">
<title>ReadMe for ICU</title>
<link rel=File-List href="./readme_files/filelist.xml">
<link rel=Edit-Time-Data href="./readme_files/editdata.mso">
<!--[if !mso]>
<style>
v\:* {behavior:url(#default#VML);}
o\:* {behavior:url(#default#VML);}
w\:* {behavior:url(#default#VML);}
.shape {behavior:url(#default#VML);}
</style>
<![endif]-->
<!--[if gte mso 9]><xml>
<o:DocumentProperties>
<o:Author>Helena Shih</o:Author>
<o:Template>Normal</o:Template>
<o:LastAuthor>Helena Shih</o:LastAuthor>
<o:Revision>4</o:Revision>
<o:TotalTime>28</o:TotalTime>
<o:Created>2000-02-01T18:26:00Z</o:Created>
<o:LastSaved>2000-02-09T20:02:00Z</o:LastSaved>
<o:Pages>11</o:Pages>
<o:Words>5177</o:Words>
<o:Characters>29510</o:Characters>
<o:Company>IBM</o:Company>
<o:Lines>245</o:Lines>
<o:Paragraphs>59</o:Paragraphs>
<o:CharactersWithSpaces>36240</o:CharactersWithSpaces>
<o:Version>9.2720</o:Version>
</o:DocumentProperties>
</xml><![endif]-->
<style>
<!--
/* Style Definitions */
p.MsoNormal, li.MsoNormal, div.MsoNormal
{mso-style-parent:"";
margin:0in;
margin-bottom:.0001pt;
mso-pagination:widow-orphan;
font-size:12.0pt;
font-family:"Times New Roman";
mso-fareast-font-family:"Times New Roman";}
a:link, span.MsoHyperlink
{color:blue;
text-decoration:underline;
text-underline:single;}
a:visited, span.MsoHyperlinkFollowed
{color:purple;
text-decoration:underline;
text-underline:single;}
p
{margin-right:0in;
mso-margin-top-alt:auto;
mso-margin-bottom-alt:auto;
margin-left:0in;
mso-pagination:widow-orphan;
font-size:12.0pt;
font-family:"Times New Roman";
mso-fareast-font-family:"Times New Roman";}
pre
{margin:0in;
margin-bottom:.0001pt;
mso-pagination:widow-orphan;
tab-stops:45.8pt 91.6pt 137.4pt 183.2pt 229.0pt 274.8pt 320.6pt 366.4pt 412.2pt 458.0pt 503.8pt 549.6pt 595.4pt 641.2pt 687.0pt 732.8pt;
font-size:10.0pt;
font-family:"Courier New";
mso-fareast-font-family:"Courier New";}
@page Section1
{size:8.5in 11.0in;
margin:1.0in 1.25in 1.0in 1.25in;
mso-header-margin:.5in;
mso-footer-margin:.5in;
mso-paper-source:0;}
div.Section1
{page:Section1;}
/* List Definitions */
@list l0
{mso-list-id:47188065;
mso-list-type:hybrid;
mso-list-template-ids:1466486202 116280834 552215838 906805068 1521137622 401357620 -1378838014 -511129794 450771094 1606707228;}
@list l1
{mso-list-id:117913232;
mso-list-type:hybrid;
mso-list-template-ids:-450314456 413984474 -860879584 458148388 1916146286 1538412862 863017768 -300143966 -55386208 -1462483600;}
@list l1:level1
{mso-level-number-format:bullet;
mso-level-text:\F0B7;
mso-level-tab-stop:.5in;
mso-level-number-position:left;
text-indent:-.25in;
mso-ansi-font-size:10.0pt;
font-family:Symbol;}
@list l2
{mso-list-id:283392397;
mso-list-type:hybrid;
mso-list-template-ids:221802328 -258441084 -934746342 1419537734 -1901567532 1981813236 287487774 2029678266 1193441118 -320863984;}
@list l3
{mso-list-id:568229750;
mso-list-type:hybrid;
mso-list-template-ids:1260177520 158890492 503090804 -1695902632 1465945538 -935272554 -2049028 941654354 -1871965178 -1305592270;}
@list l3:level1
{mso-level-number-format:bullet;
mso-level-text:\F0B7;
mso-level-tab-stop:.5in;
mso-level-number-position:left;
text-indent:-.25in;
mso-ansi-font-size:10.0pt;
font-family:Symbol;}
@list l4
{mso-list-id:576742058;
mso-list-type:hybrid;
mso-list-template-ids:-715868556 -132768664 498237874 598241330 -1517910766 -1750947490 714492842 1225816080 -2059080712 393093814;}
@list l4:level1
{mso-level-number-format:bullet;
mso-level-text:\F0B7;
mso-level-tab-stop:.5in;
mso-level-number-position:left;
text-indent:-.25in;
mso-ansi-font-size:10.0pt;
font-family:Symbol;}
@list l5
{mso-list-id:664672491;
mso-list-type:hybrid;
mso-list-template-ids:1772678752 2062991906 446980294 -161209628 -100250862 2128757756 2052650808 -538035208 -6270306 291808606;}
@list l5:level1
{mso-level-number-format:bullet;
mso-level-text:\F0B7;
mso-level-tab-stop:.5in;
mso-level-number-position:left;
text-indent:-.25in;
mso-ansi-font-size:10.0pt;
font-family:Symbol;}
@list l6
{mso-list-id:836961509;
mso-list-type:hybrid;
mso-list-template-ids:-224895454 -1014200752 826189550 -2031309554 1889069730 -609042030 1875430626 1998766280 1070782366 1076102286;}
@list l6:level1
{mso-level-number-format:bullet;
mso-level-text:\F0B7;
mso-level-tab-stop:.5in;
mso-level-number-position:left;
text-indent:-.25in;
mso-ansi-font-size:10.0pt;
font-family:Symbol;}
@list l7
{mso-list-id:913508786;
mso-list-type:hybrid;
mso-list-template-ids:1568069976 -1959095566 -768301796 -931790726 -2143009482 1948575304 -712632468 -697775276 -403279512 968792852;}
@list l7:level1
{mso-level-number-format:bullet;
mso-level-text:\F0B7;
mso-level-tab-stop:.5in;
mso-level-number-position:left;
text-indent:-.25in;
mso-ansi-font-size:10.0pt;
font-family:Symbol;}
@list l7:level2
{mso-level-number-format:bullet;
mso-level-text:o;
mso-level-tab-stop:1.0in;
mso-level-number-position:left;
text-indent:-.25in;
mso-ansi-font-size:10.0pt;
font-family:"Courier New";
mso-bidi-font-family:"Times New Roman";}
@list l8
{mso-list-id:991719643;
mso-list-type:hybrid;
mso-list-template-ids:2129591196 1460462400 -1172699750 1169610458 -437120214 1872653486 -842923700 841514964 2136911810 1364103300;}
@list l9
{mso-list-id:1115171434;
mso-list-type:hybrid;
mso-list-template-ids:-1407672820 -1016529878 1566456998 -99162944 1112470608 1354390290 1532235962 643100262 1447355994 -1094388302;}
@list l10
{mso-list-id:1133790422;
mso-list-type:hybrid;
mso-list-template-ids:602321612 -1181957080 -1020131346 -1755803318 646190636 122975578 1475804658 -455318736 -1891325090 -1214717408;}
@list l10:level1
{mso-level-number-format:bullet;
mso-level-text:\F0B7;
mso-level-tab-stop:.5in;
mso-level-number-position:left;
text-indent:-.25in;
mso-ansi-font-size:10.0pt;
font-family:Symbol;}
@list l10:level2
{mso-level-number-format:bullet;
mso-level-text:o;
mso-level-tab-stop:1.0in;
mso-level-number-position:left;
text-indent:-.25in;
mso-ansi-font-size:10.0pt;
font-family:"Courier New";
mso-bidi-font-family:"Times New Roman";}
@list l11
{mso-list-id:1170366750;
mso-list-type:hybrid;
mso-list-template-ids:139625938 1784856908 14434230 2135990762 205005018 -1679018944 -78496528 941265532 136326846 -2030939902;}
@list l12
{mso-list-id:1395081028;
mso-list-type:hybrid;
mso-list-template-ids:-1450152516 594060610 -1995156862 -742472460 1399253788 775304844 -332753902 -90000986 -656356064 -1128074476;}
@list l12:level1
{mso-level-number-format:bullet;
mso-level-text:\F0B7;
mso-level-tab-stop:.5in;
mso-level-number-position:left;
text-indent:-.25in;
mso-ansi-font-size:10.0pt;
font-family:Symbol;}
@list l13
{mso-list-id:1410885180;
mso-list-type:hybrid;
mso-list-template-ids:-1420239212 -2078642128 1381369862 486155864 -1973497194 1050204580 -46207730 -508368526 1735818270 669444066;}
@list l13:level1
{mso-level-number-format:bullet;
mso-level-text:\F0B7;
mso-level-tab-stop:.5in;
mso-level-number-position:left;
text-indent:-.25in;
mso-ansi-font-size:10.0pt;
font-family:Symbol;}
@list l14
{mso-list-id:1558080398;
mso-list-type:hybrid;
mso-list-template-ids:-720580774 1417685988 1440894936 -1423303424 -193586832 898255738 -212563752 725117368 1124212432 2069772174;}
@list l14:level1
{mso-level-number-format:bullet;
mso-level-text:\F0B7;
mso-level-tab-stop:.5in;
mso-level-number-position:left;
text-indent:-.25in;
mso-ansi-font-size:10.0pt;
font-family:Symbol;}
@list l15
{mso-list-id:1927837791;
mso-list-type:hybrid;
mso-list-template-ids:1363567226 -2132220750 875589078 1199445854 -582346952 944043046 -49528938 -394654148 1636605060 -183584940;}
@list l15:level1
{mso-level-number-format:bullet;
mso-level-text:\F0B7;
mso-level-tab-stop:.5in;
mso-level-number-position:left;
text-indent:-.25in;
mso-ansi-font-size:10.0pt;
font-family:Symbol;}
@list l15:level2
{mso-level-number-format:bullet;
mso-level-text:o;
mso-level-tab-stop:1.0in;
mso-level-number-position:left;
text-indent:-.25in;
mso-ansi-font-size:10.0pt;
font-family:"Courier New";
mso-bidi-font-family:"Times New Roman";}
@list l16
{mso-list-id:2067096185;
mso-list-type:hybrid;
mso-list-template-ids:582122176 -1729593526 -491090842 -1692663546 -1673229800 1254113432 1459242370 292878442 -961933704 -1788173682;}
@list l16:level1
{mso-level-number-format:bullet;
mso-level-text:\F0B7;
mso-level-tab-stop:.5in;
mso-level-number-position:left;
text-indent:-.25in;
mso-ansi-font-size:10.0pt;
font-family:Symbol;}
ol
{margin-bottom:0in;}
ul
{margin-bottom:0in;}
-->
</style>
<!--[if gte mso 9]><xml>
<o:shapedefaults v:ext="edit" spidmax="1027"/>
</xml><![endif]-->
<!--[if gte mso 9]><xml>
<o:shapelayout v:ext="edit">
<o:idmap v:ext="edit" data="1"/>
</o:shapelayout></xml><![endif]-->
</head>
<body bgcolor="#FFFFFF" link="#0000FF" vlink="#800080" lang="EN-US" style="tab-interval:.5in">
<div class=Section1>
<h2>
ReadMe: International Components for Unicode for Java</h2>
Version: February 1, 2000
<div class="MsoNormal" style="text-align:center">
<center>
<hr size=2 width="100%" align=center></center>
</div>
COPYRIGHT:
<br>Copyright (c) 2000 International Business Machines Corporation and
others. All Rights Reserved.
<div class="MsoNormal" style="text-align:center">
<center>
<hr size=2 width="100%" align=center></center>
</div>
<br>&nbsp;
<h3>
<u>Contents</u></h3>
<ul type=disc>
<li class="MsoNormal" style="mso-margin-top-alt:auto;mso-margin-bottom-alt:auto;
mso-list:l3 level1 lfo3;tab-stops:list .5in">
<a href="#introduction">Introduction</a></li>
<li class="MsoNormal" style="mso-margin-top-alt:auto;mso-margin-bottom-alt:auto;
mso-list:l3 level1 lfo3;tab-stops:list .5in">
<a href="#WhatContain">What the International Components for Unicode for
Java Contain</a></li>
<li class="MsoNormal" style="mso-margin-top-alt:auto;mso-margin-bottom-alt:auto;
mso-list:l3 level1 lfo3;tab-stops:list .5in">
<a href="#API">API overview</a></li>
<li class="MsoNormal" style="mso-margin-top-alt:auto;mso-margin-bottom-alt:auto;
mso-list:l3 level1 lfo3;tab-stops:list .5in">
<a href="#PlatformDependencies">Platform Dependencies</a></li>
<li class="MsoNormal" style="mso-margin-top-alt:auto;mso-margin-bottom-alt:auto;
mso-list:l3 level1 lfo3;tab-stops:list .5in">
<a href="#HowToInstall">How to Install/Build</a></li>
<li class="MsoNormal" style="mso-margin-top-alt:auto;mso-margin-bottom-alt:auto;
mso-list:l3 level1 lfo3;tab-stops:list .5in">
<a href="#WhereToFindMore">Where to Find More Information</a></li>
<li class="MsoNormal" style="mso-margin-top-alt:auto;mso-margin-bottom-alt:auto;
mso-list:l3 level1 lfo3;tab-stops:list .5in">
<a href="#SubmittingComments">Submitting Comments, Requesting Features
and Reporting Bugs</a></li>
</ul>
<h3>
<a NAME="introduction"></a><u>Introduction</u></h3>
Today's software market is a global one in which it is desirable to develop
and maintain one application that supports a wide variety of national languages.
International Components for Unicode for Java provides the following tools
to help you write language independent applications:
<ul type=disc>
<li class="MsoNormal" style="mso-margin-top-alt:auto;mso-margin-bottom-alt:auto;
mso-list:l5 level1 lfo6;tab-stops:list .5in">
International Calendars <20> Arabic, Buddhist, Hebrew, Japanese</li>
<li class="MsoNormal" style="mso-margin-top-alt:auto;mso-margin-bottom-alt:auto;
mso-list:l5 level1 lfo6;tab-stops:list .5in">
Unicode Normalization <20> Canonical text representation for W3C</li>
<li class="MsoNormal" style="mso-margin-top-alt:auto;mso-margin-bottom-alt:auto;
mso-list:l5 level1 lfo6;tab-stops:list .5in">
Number Format Enhancements <20> Scientific Notation, Spelled-out, ...</li>
<li class="MsoNormal" style="mso-margin-top-alt:auto;mso-margin-bottom-alt:auto;
mso-list:l5 level1 lfo6;tab-stops:list .5in">
Enhanced word-break detection <20> Rule-based, supports Thai</li>
<li class="MsoNormal" style="mso-margin-top-alt:auto;mso-margin-bottom-alt:auto;
mso-list:l5 level1 lfo6;tab-stops:list .5in">
Unicode Text Searching <20> Efficient multi-lingual searching</li>
<li class="MsoNormal" style="mso-margin-top-alt:auto;mso-margin-bottom-alt:auto;
mso-list:l5 level1 lfo6;tab-stops:list .5in">
Unicode Text Compression <20> 2:1 compression on English Unicode text</li>
</ul>
Your comments are important to making this release successful.&nbsp; We
are committed to fixing any bugs, and will also use your feedback to help
plan future releases.
<p style="margin-right:.5in;margin-left:.5in"><b><u>IMPORTANT</u>: Please
make sure you understand the <a href="license.html">Copyright and License
information</a>.</b>
<br>&nbsp;
<br>&nbsp;
<h3>
<a NAME="WhatContain"></a><u>What the International Components for Unicode
for Java Contain</u></h3>
There are two ways to download the ICU4J releases,
<ul type=disc>
<li class="MsoNormal" style="mso-margin-top-alt:auto;mso-margin-bottom-alt:auto;
mso-list:l10 level1 lfo9;tab-stops:list .5in">
<b>Official Release Snapshot:</b></li>
<br>If you want to use ICU4J (as opposed to developing it), your best bet
is to download an official, packaged ICU4J version of the ICU4J source
code.&nbsp; These versions are tested more thoroughly than day-to-day development
builds, and they are packaged in zip and tar files for convenient download.&nbsp;
These packaged files can be found at <a href="http://oss.software.ibm.com/developerworks/opensource/icu4j/project/download/index.html">http://oss.software.ibm.com/developerworks/opensource/icu4j/project/download/index.html</a>.
<br>If packaged snapshot is named <b>ICU4JXXXXXX.zip </b>, XXXXXX is the
release version number.
<br>Please unzip this file.&nbsp; It will re-construct the source directory.
<li class="MsoNormal" style="mso-margin-top-alt:auto;mso-margin-bottom-alt:auto;
mso-list:l10 level1 lfo9;tab-stops:list .5in">
<b>CVS Source Repository:</b></li>
<br>If you are interested in developing features, patches, or bug fixes
for ICU4J, you should probably be working with the latest version of the
ICU4J source code. You will need to check the code out of our CVS repository
to ensure that you have the most recent version of all of the files. There
are several ways to do this:
<ul type=circle>
<li class="MsoNormal" style="mso-margin-top-alt:auto;mso-margin-bottom-alt:
auto;mso-list:l10 level2 lfo9;tab-stops:list 1.0in">
WebCVS:</li>
<br>If you want to browse the code and only make occasional downloads,
you may want to use WebCVS. It provides a convenient, web-based interface
for browsing and downloading the latest version of the ICU4J source code
and documentation. You can also view each file's revision history, display
the differences between individual revisions, determine which revisions
were part of which official release, and so on.
<li class="MsoNormal" style="mso-margin-top-alt:auto;mso-margin-bottom-alt:
auto;mso-list:l10 level2 lfo9;tab-stops:list 1.0in">
WinCVS:</li>
<br>If you will be doing serious work on ICU4J, you should probably install
a CVS client on your own machine so that you can do batch operations without
going through the WebCVS interface. On Windows, we suggest the WinCVS client.
The following is the example instruction on how to download ICU4J via WinCVS:
<br>1.Install the WinCVS client, which you can download from the WinCVS
home page.
<br>2.In the WinCVS preferences, specify your CVSRoot to be ":pserver:anoncvs@oss.software.ibm.com:/usr/cvs/icu4j"
<br>with the password "anoncvs". To enter the CVSRoot value, select "Preferences"
from the "Cvs Admin" pull-down menu.&nbsp;&nbsp;&nbsp; Authentication should
be set to "'passwd' file on the cvs server".
<br>3.To "extract" the most recent version of ICU4J, select "Checkout module"
from the "Cvs Admin" menu. Specify "icu4j" for the module name.
<li class="MsoNormal" style="mso-margin-top-alt:auto;mso-margin-bottom-alt:
auto;mso-list:l10 level2 lfo9;tab-stops:list 1.0in">
CVS command line:</li>
<br>You can also check out the repository anonymously on UNIX using the
following commands, after first setting your CVSROOT to point to the ICU4J
repository:
<p>export CVSROOT=:pserver:anoncvs@oss.software.ibm.com:/usr/cvs/icu4j
<br>cvs login CVS password: anoncvs
<br>cvs checkout icu4j
<br>cvs logout</ul>
</ul>
For more details on how to download ICU4J directly from the web site, please
also see <a href="http://oss.software.ibm.com/developerworks/opensource/icu4j/project/download/index.html">http:/oss.software.ibm.com/developerworks/opensource/icu4j/project/download/index.html</a>
<p>Below, <b>$Root</b> is the placement of the icu directory in your file
system, like "drive:\...\icu4j" in your environment. "drive:\..." stands
for any drive and any directory on that drive that you chose to install
icu4j into.
<br>&nbsp;
<p><b>The following files describe the code drop:</b>
<br>&nbsp;
<table BORDER CELLPADDING=0 style="mso-cellspacing:1.5pt;mso-padding-alt:
0in 0in 0in 0in" >
<tr>
<td style="padding:.75pt .75pt .75pt .75pt">
<div class="MsoNormal">readme.html (this file)</div>
</td>
<td style="padding:.75pt .75pt .75pt .75pt">
<div class="MsoNormal">describes the International Components for Unicode
for Java</div>
</td>
</tr>
<tr>
<td style="padding:.75pt .75pt .75pt .75pt">
<div class="MsoNormal">license.html</div>
</td>
<td style="padding:.75pt .75pt .75pt .75pt">
<div class="MsoNormal">contains IBM's public license</div>
</td>
</tr>
</table>
<p><b>The source directories mirror package structure of the code.&nbsp;
The following directories contain source code and data files:</b>
<br>&nbsp;
<table BORDER CELLPADDING=0 WIDTH="623" style="width:467.25pt;mso-cellspacing:
1.5pt;mso-padding-alt:0in 0in 0in 0in" >
<tr>
<td WIDTH="20%" style="width:20.0%;padding:.75pt .75pt .75pt .75pt">
<div class="MsoNormal">$Root/src/data/</div>
</td>
<td WIDTH="80%" style="width:80.0%;padding:.75pt .75pt .75pt .75pt">
<div class="MsoNormal">Various data files used to generate ICU4J classes.&nbsp;
Most of the files contain Unicode information that is available from <a href="http://www.unicode.org/">http://www.unicode.org/</a>.&nbsp;
Used only by tools in the src/com/ibm/tools.</div>
</td>
</tr>
<tr>
<td WIDTH="20%" style="width:20.0%;padding:.75pt .75pt .75pt .75pt">
<div class="MsoNormal">$Root/src/com/ibm/demo</div>
</td>
<td WIDTH="80%" style="width:80.0%;padding:.75pt .75pt .75pt .75pt">
<div class="MsoNormal">Demonstration applications and Applets.</div>
</td>
</tr>
<tr>
<td WIDTH="20%" style="width:20.0%;padding:.75pt .75pt .75pt .75pt">
<div class="MsoNormal">$Root/src/com/ibm/test</div>
</td>
<td WIDTH="80%" style="width:80.0%;padding:.75pt .75pt .75pt .75pt">
<div class="MsoNormal">Tests for various ICU4J components.. For information
about running the tests, see <a href="api/com/ibm/test/topleveltest/TestAll.html">$Root/docs/com/ibm/test/topleveltest/TestAll.html</a>.</div>
</td>
</tr>
<tr>
<td WIDTH="20%" style="width:20.0%;padding:.75pt .75pt .75pt .75pt">
<div class="MsoNormal">$Roo/src/com/ibm/tools</div>
</td>
<td WIDTH="80%" style="width:80.0%;padding:.75pt .75pt .75pt .75pt">
<div class="MsoNormal">Various tools used to generate ICU4J classes.&nbsp;
<a href="docs/cintltst.html">$Root/src/com/ibm/tools</a></div>
</td>
</tr>
<tr>
<td WIDTH="20%" style="width:20.0%;padding:.75pt .75pt .75pt .75pt">
<div class="MsoNormal">$Root/src/com/ibm/text</div>
</td>
<td WIDTH="80%" style="width:80.0%;padding:.75pt .75pt .75pt .75pt">
<div class="MsoNormal">The following components:
<li>
RuleBasedBreakIterator</li>
<li>
DictionaryBasedBreakIterator</li>
<li>
Transliterator</li>
<li>
Normalizer</li>
<li>
BigNumberFormat</li>
<li>
StringSearch</li>
<li>
Unicode compression</li>
</div>
</td>
</tr>
<tr>
<td WIDTH="20%" style="width:20.0%;padding:.75pt .75pt .75pt .75pt">
<div class="MsoNormal">$Root/src/com/ibm/util</div>
</td>
<td WIDTH="80%" style="width:80.0%;padding:.75pt .75pt .75pt .75pt">
<div class="MsoNormal">Calendars and Holidays</div>
</td>
</tr>
<tr>
<td WIDTH="20%" style="width:20.0%;padding:.75pt .75pt .75pt .75pt">
<div class="MsoNormal">$Root/build</div>
</td>
<td WIDTH="80%" style="width:80.0%;padding:.75pt .75pt .75pt .75pt">
<div class="MsoNormal">Additional classes needed to build using Ant</div>
</td>
</tr>
</table>
<p><b>The following directories are populated when you've built everything:</b>
<br>&nbsp;
<table BORDER CELLPADDING=0 style="mso-cellspacing:1.5pt;mso-padding-alt:
0in 0in 0in 0in" >
<tr>
<td style="padding:.75pt .75pt .75pt .75pt">
<div class="MsoNormal">$Root/classes/</div>
</td>
<td style="padding:.75pt .75pt .75pt .75pt">
<div class="MsoNormal">contains all class files</div>
</td>
</tr>
<tr>
<td style="padding:.75pt .75pt .75pt .75pt">
<div class="MsoNormal">$Root/docs</div>
</td>
<td style="padding:.75pt .75pt .75pt .75pt">
<div class="MsoNormal">contains JavaDoc for all packages</div>
</td>
</tr>
</table>
<h3>
<a NAME="API"></a><u>API Overview</u></h3>
The complete API documentation is available on the ICU4J web sight:
<br>&nbsp;
<li class="MsoNormal" style="mso-margin-top-alt:auto;mso-margin-bottom-alt:auto;
mso-list:l5 level1 lfo6;tab-stops:list .5in">
<a href="javadoc/index.html">Complete index</a></li>
<li class="MsoNormal" style="mso-margin-top-alt:auto;mso-margin-bottom-alt:auto;
mso-list:l5 level1 lfo6;tab-stops:list .5in">
International Calendars <20> <a href="javadoc/com/ibm/util/IslamicCalendar.html">Islamic</a>,
<a href="javadoc/com/ibm/util/BuddhistCalendar.html">Buddhist</a>,
<a href="javadoc/com/ibm/util/HebrewCalendar.html">Hebrew</a>,
<a href="javadoc/com/ibm/util/JapaneseCalendar.html">Japanese</a></li>
<li class="MsoNormal" style="mso-margin-top-alt:auto;mso-margin-bottom-alt:auto;
mso-list:l5 level1 lfo6;tab-stops:list .5in">
<a href="javadoc/com/ibm/text/Normalizer.html">Unicode Normalization</a>
<EFBFBD> Canonical text representation for W3C</li>
<li class="MsoNormal" style="mso-margin-top-alt:auto;mso-margin-bottom-alt:auto;
mso-list:l5 level1 lfo6;tab-stops:list .5in">
<a href="javadoc/com/ibm/text/NumberFormat.html">Number Format Enhancements</a>
<EFBFBD> Scientific Notation, Spelled-out, ...</li>
<li class="MsoNormal" style="mso-margin-top-alt:auto;mso-margin-bottom-alt:auto;
mso-list:l5 level1 lfo6;tab-stops:list .5in">
<a href="javadoc/com/ibm/text/BreakIterator.html">Enhanced word-break detection</a>
<EFBFBD> Rule-based, supports Thai</li>
<li class="MsoNormal" style="mso-margin-top-alt:auto;mso-margin-bottom-alt:auto;
mso-list:l5 level1 lfo6;tab-stops:list .5in">
<a href="javadoc/com/ibm/text/StringSearch.html">Unicode Text Searching</a>
<EFBFBD> Efficient multi-lingual searching</li>
<li class="MsoNormal" style="mso-margin-top-alt:auto;mso-margin-bottom-alt:auto;
mso-list:l5 level1 lfo6;tab-stops:list .5in">
Unicode Text <a href="javadoc/com/ibm/text/UnicodeCompressor.html">Compression</a>
&amp; <a href="javadoc/com/ibm/text/UnicodeDecompressor.html">Decompression</a>
<EFBFBD> 2:1 compression on English Unicode text</li>
<br>&nbsp;
<h3>
<a NAME="PlatformDependencies"></a><u>Platform Dependencies</u></h3>
Parts of ICU4J depend on functionality that is only available in Java2
(JDk1.2) or later, although some components work under 1.1.&nbsp; However,
all components should be compiled using a Java2 compiler as even components
that run using a 1.1.x JVM may require language features that are only
present in 1.2.&nbsp; Currently 1.1.x is unsupported and untested and you
use the components on a 1.1.x system at your own risk.
<br>&nbsp;
<h3>
<a NAME="HowToInstall"></a><u>How to Install/Build using Ant</u></h3>
To install the ICU4J source code simply unzip the icu4j-XXX.zip file by
typing "unzip -a icu4j-XXX.zip -d drive:\directory" under the command prompt.
<p>Ant is a Java based build system developed for the Jakarta (part of
Apache) project.&nbsp; It can be downloaded from the Jakarta websight at:
<a href="http://jakarta.apache.org/downloads/binindex.html">http://jakarta.apache.org/downloads/binindex.html.</a>&nbsp;
Download the latest Jakarta-tools archive (<a href="http://jakarta.apache.org/builds/tomcat/release/v3.1_beta_1/bin/jakarta-tools.tar.gz">http://jakarta.apache.org/builds/tomcat/release/v3.1_beta_1/bin/jakarta-ant.zip</a>).
<p>The steps for installing Ant are:
<br>Move the Jakarta-ant.zip file into the root ICU4J folder (at the same
level with the src and build folders).
<br>Unzip the tools into the ICU4J root folder, type "unzip -a jakarta-ant.zip"
<br>Type "Build all" or "Build.sh all" under Unix.
<p>The resulting classes are put in the "classes" directory, the JavaDoc
is put in the "docs" directory, and a jar file is put in the top ICU4J
directory.
<p>At this point it is probably a good idea to run all the tests by typeing
"java -classpath classes com.ibm.test.topleveltest.TestAll".
<h3>
<a NAME="WhereToFindMore"></a><u>Where to Find More Information</u></h3>
<a href="http://oss.software.ibm.com/icu4j">http://oss.software.ibm.com/icu4j</a>
is a pointer to general information about the International Components
for Unicode in Java
<p><a href="http://www.ibm.com/unicode">http://www.ibm.com/unicode</a>
is a pointer to information on how to make applications global.
<br>&nbsp;
<h3>
<a NAME="SubmittingComments"></a><u>Submitting Comments, Requesting Features
and Reporting Bugs</u></h3>
To submit comments, request features and report bugs, please contact us.&nbsp;
While we are not able to respond individually to each comment, we do review
all comments. Send Internet email to <a href="mailto:icu4j@oss.software.ibm.com">icu4j@oss.software.ibm.com</a>.
<div class="MsoNormal" style="text-align:center">
<center>
<hr size=2 width="100%" align=center></center>
</div>
Copyright &copy; 2000 International Business Machines Corporation and others.
All Rights Reserved.
<br>IBM Center for Java Technology Silicon Valley,
<br>10275 N De Anza Blvd., Cupertino, CA 95014
<br>All rights reserved.
<div class="MsoNormal" style="text-align:center">
<center>
<hr size=2 width="100%" align=center></center>
</div>
</div>
</body>
</html>