blob: d46defd9b747be44e4a4a830d29ee92517411910 [file] [log] [blame]
<!doctype html public "-//w3c//dtd html 4.0 transitional//en">
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
<title>ReadMe for ICU4J</title>
<body bgcolor="#FFFFFF" link="#0000FF" vlink="#800080" lang="EN-US">
<h2>ReadMe: International Components for Unicode for Java</h2>
<p>Version: 1.3.1 June 12 2001 </p>
<hr size="2" width="100%" align="center">
<p>COPYRIGHT: <br>
Copyright (c) 2001 International Business Machines Corporation and others. All Rights
Reserved. </p>
<hr size="2" width="100%" align="center">
<ul type="disc">
<li><a href="#introduction">Introduction</a></li>
<li><a href="#license">License Information</a></li>
<li><a href="#WhatContain">What the International Components for Unicode for Java Contains</a></li>
<li><a href="#API">API overview</a></li>
<li><a href="#PlatformDependencies">Platform Dependencies</a></li>
<li><a href="#HowToInstallJavac">How to Install and Build</a></li>
<li><a href="#WhereToFindMore">Where to Find More Information</a></li>
<li><a href="#SubmittingComments">Submitting Comments, Requesting Features and Reporting
<h3><a NAME="introduction"></a><u>Introduction</u></h3>
In today's global market, it is crucial to develop and maintain programs that support a wide variety of national languages. Customers prefer software and web pages in their own languages. Studies confirm that this leads to increased sales. Java provides a very strong foundation for global
programs (IBM and the ICU4J team played a key role in providing such technology into Sun's standard Java version).
However, Java does not yet provide some features that are required in some products. The ICU4J library is an add-on to the regular JVM that provides the following tools:
Unicode Normalization – NFC, NFD, NFKD, NFKC
<blockquote>Produces canonical text representations, needed for XML and the net</blockquote>
International Calendars – Arabic, Buddhist, Hebrew, and Japanese
<blockquote>Required for correct presentation of dates in some countries.</blockquote>
Number Format Enhancements – Scientific Notation, Spelled-out, etc.
<blockquote>Enhances the normal Java number formatting. The spell-out format is used
for checks and similar documents.</blockquote>
<li>Enhanced word-break detection – Rule-based, supports Thai
<blockquote>Required for correct support of Thai.</blockquote>
<li>Unicode Text Compression – Standard compression of Unicode text
<blockquote>Suitable for large numbers of small fields, where LZW and similar schemes
do not apply</blockquote>
In some cases, the above support has been rolled into a later release of
Java. For example, the Thai word-break is now in Java 1.4. However, if you
are using Java 1.2, you can use the ICU4J package until you upgrade to 1.4.
<h3><a name=license></a><u>License Information</u></h3>
The ICU projects (ICU4C and ICU4J) have changed their licenses from the IPL (IBM Public License) to the X license. The X license is a non-viral and recommended free software license that is compatible with the GNU GPL license. This is effective starting with release 1.8.1 of ICU4C and release 1.3.1 of ICU4J. All previous ICU releases will continue to utilize the IPL. New ICU releases will adopt the X license. The users of previous releases of ICU will need to accept the terms and conditions of the X license in order to adopt the new ICU releases.
The main effect of the change is to provide GPL compatibility. The X license is listed as GPL compatible, see the gnu page at <a href=>
The text of the X license is available at <a href=></a>. The IBM version contains the essential text of the license, omitting the X-specific trademarks and copyright notices.
For more details please see the <a href=>press announcement</a> and the <a href=>Project FAQ</a>.
<h3><a NAME="WhatContain"></a><u>What the International Components for Unicode for Java
<p>There are two ways to download the ICU4J releases,
<ul type="disc">
<li><b>Official Release Snapshot:</b><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 files for
convenient download.&nbsp; These packaged files can be found at <a href=""></a>.
If packaged snapshot is named <b> </b>, XXXXXX is the release version
number. <br>
Please unzip this file.&nbsp; It will re-construct the source directory. </li>
<ul type="disc">
<li><b>CVS Source Repository:</b><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: <br>
<ul type="circle">
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. <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: <ol>
<li>Install the WinCVS client, which you can download from the <a
<li>Select <strong>Preferences</strong> from the <strong>Admin</strong> menu.<ol type="a">
<li>On the <strong>General</strong> tab panel: Set your <strong>CVSROOT</strong> to &quot;<strong></strong>&quot;.<br>
Leave other options on this page at their default.</li>
<li>On the <strong>Ports</strong> tab panel: Check the <strong>pserver</strong> checkbox and
enter port <strong>2401</strong>.</li>
<li>Click on the Login menu button (<strong>Admin</strong> menu). Enter in &quot;<strong>anoncvs</strong>&quot; when requested.</li>
<li>To extract the most recent version of ICU4J, select <strong>Checkout module</strong>
from the <strong>Create</strong> menu. Specify &quot;<strong>icu4j</strong>&quot; for the
module name. This will create a new copy of the workspace on your local hard drive.</li>
<li>In the future, you can download updated files from the repository to your hard drive
using the <strong>Update selection</strong> item in the <strong>Modify</strong> menu.<br>
<li>CVS command line:<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: <pre><code>export
cvs login CVS password: anoncvs
cvs checkout icu4j
cvs logout</code></pre>
<p>For more details on how to download ICU4J directly from the web site, please also see <a
<p>Below, <b>$Root</b> is the placement of the icu directory in your file system, like
&quot;drive:\...\icu4j&quot; in your environment. &quot;drive:\...&quot; stands for any
drive and any directory on that drive that you chose to install icu4j into. </p>
<p><b>The following files describe the code drop:</b></p>
<table BORDER="1" CELLPADDING="0">
<td>readme.html (this file)</td>
<td>describes the International Components for Unicode for Java</td>
<td>contains the X license</td>
<p><b>The source directories mirror package structure of the code.&nbsp; The following
directories contain source code and data files:</b> </p>
<table BORDER="1" CELLPADDING="0" WIDTH="623">
<td WIDTH="20%">$Root/src/data/</td>
<td WIDTH="80%">Various data files used to generate ICU4J classes.&nbsp; Most of the files
contain Unicode information that is available from <a href=""></a>.&nbsp;
Used only by tools in the src/com/ibm/tools.</td>
<td WIDTH="20%">$Root/src/com/ibm/demo</td>
<td WIDTH="80%">Demonstration applications and Applets.</td>
<td WIDTH="20%">$Root/src/com/ibm/test</td>
<td WIDTH="80%">Tests for various ICU4J components.. For information about running the
tests, see $Root/src/com/ibm/test/</td>
<td WIDTH="20%">$Root/src/com/ibm/tools</td>
<td WIDTH="80%">Various tools used to generate ICU4J classes.</td>
<td WIDTH="20%">$Root/src/com/ibm/text</td>
<td WIDTH="80%">The following components:&nbsp; <ul>
<li>Unicode compression</li>
<td WIDTH="20%">$Root/src/com/ibm/util</td>
<td WIDTH="80%">Calendars and Holidays</td>
<td WIDTH="20%">$Root/build</td>
<td WIDTH="80%">Additional classes needed to build using Ant</td>
<p><b>The following directories are populated when you've built everything:</b> </p>
<table BORDER="1" CELLPADDING="0">
<td>contains all class files</td>
<td>contains JavaDoc for all packages</td>
<p><b>Data organization:</b> </p>
<p>Data is stored in various locations in ICU4J:
<li>Data that is &quot;raw&quot; data goes into <strong>$Root/src/data</strong>. This
includes things like the raw Unicode database. <strong>$Root/src/data</strong> does <em>not</em>
contain <strong>.java</strong> source files.</li>
<li>Data that is in the form of a Java class, typically a ResourceBundle, but not
necessarily, goes into one of the packages <code></code> or <code></code>,
depending on whether the associated code lives in <code></code> or <code></code>.</li>
<li>Data that is not part of ICU4J proper (or its base tool set), but rather part of a test,
sample, or demo, should go near the source code of its owner. This makes it easy to ship a
core ICU4J release without optional components.</li>
<h3><u><a name="API"></a>API Overview</u></h3>
<p>The complete API documentation is available on the ICU4J web site:
<li><a href="">Complete index</a></li>
<li>International Calendars &#150; <a href="">Islamic</a>,
<a href="">Buddhist</a>, <a
href="">Hebrew</a>, <a
<li><a href="">Unicode Normalization</a> &#150;
Canonical text representation for W3C</li>
<li><a href="">Number Format Enhancements</a> &#150;
Scientific Notation, Spelled-out, ...</li>
<li><a href="">Enhanced word-break detection</a>
&#150; Rule-based, supports Thai</li>
<li><a href="">Unicode Text Searching</a> &#150;
Efficient multi-lingual searching</li>
<li>Unicode Text <a href="">Compression</a> &amp;
<a href="">Decompression</a> &#150; 2:1
compression on English Unicode text</li>
<h3><a NAME="PlatformDependencies"></a><u>Platform Dependencies</u></h3>
<p>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. </p>
<h3><a NAME="HowToInstallJavac"></a><u>How to Install and Build</u></h3>
<p>To install ICU4J, simply place the prebuilt jar file <strong>icu4j.jar</strong> on your
Java CLASSPATH.&nbsp; No other files are needed.</p>
<p>The prerequisites for building ICU4J are a working JDK and the Ant build system:
<li>First install a recent JDK, at least version 1.2.</li>
<li>Next install the <a href=""><strong>Ant</strong></a> build
system, part of the Apache Software Foundation's <a href=""><strong>Jakarta</strong></a>
project. Ant is a portable, Java-based build system similar to make. ICU4J uses Ant
because it introduces no other dependencies, it's portable, and it's easier to manage than
a collection of makefiles. We currently build ICU4J using a single makefile on both
Windows 9x and Linux using Ant.</li>
<li>Installing Ant is straightforward. Download it (see <a
extract it onto your system, set some environment variables, and add its bin directory to
your path. For example:<pre> set JAVA_HOME=C:\jdk1.2.2
set ANT_HOME=C:\jakarta-ant
set PATH=%PATH%;%ANT_HOME%\bin
call antsetup</pre>
<p>See the current Ant documentation for details.</p>
<li>It's recommended to install both the JDK and Ant somewhere <em>outside</em> the ICU4J
directory, to keep them out of CVS's hair. For example, on Linux you might install these
in /usr/local.</li>
<p>Once Ant is installed, building is just a matter of typing <strong>ant</strong> in the
ICU4J root directory. This causes the Ant build system to perform a build as specified by
the file <strong>build.xml</strong>, located in the ICU4J root directory. You can give Ant
options like -verbose, and you can specify targets. Ant will only build what's been
changed and will resolve dependencies properly.</p>
<pre>F:\icu4j&gt;ant tests
Buildfile: build.xml
Project base dir set to: F:\icu4j
Executing Target: core
Compiling 71 source files to F:\icu4j\classes
Executing Target: tests
Compiling 24 source files to F:\icu4j\classes
Completed in 19 seconds</pre>
<p>Current targets that you can give after <strong>ant</strong>:</p>
<div align="left">
<table border="1" cellpadding="0">
<td>Build all targets.</td>
<td>Build the main class files in the subdirectory <strong>classes</strong>. If no target
is specified, core is assumed.</td>
<td>Build the test class files.</td>
<td>Build the demos.</td>
<td>Build the tools.</td>
<td>Run javadoc over the main class files, generating an HTML documentation tree in the
subdirectory <strong>doc</strong>.</td>
<td>Create a jar archive <strong>icu4j.jar</strong> in the root ICU4J directory containing
the main class files.</td>
<td>Create a zip archive of the source, docs, and jar file for distribution, excluding
unwanted things like CVS directories and emacs backup files. The zip file <strong></strong>
will be created in the directory <em>above</em> the root ICU4J directory, where YYYYMMDD
is today's date. Any existing file of that name will be overwritten.</td>
<td>Like the <strong>zip</strong> target, without the docs and the jar file. The zip file <strong></strong>
will be created in the directory <em>above</em> the root ICU4J directory.</td>
<td>Remove all built targets, leaving the source.</td>
<p>For more information, read the Ant documentation and the <strong>build.xml</strong>
<p>After doing a build it is a good idea to run all the tests by typing <br>&quot;java
-classpath $Root/classes -DUnicodeData=$Root/src/data/unicode/UnicodeData.txt;. </p>
<p>(As an alternative to using Ant, you can build simply by running javac and javadoc
directly. This is not recommended, but a Windows batch file &quot;buildall.bat&quot;
exists to get you started if you're really allergic to build systems. You may have to
create destination directories.)</p>
<h3><a name="WhereToFindMore"></a><u>Where to Find More Information</u></h3>
<p><a href=""></a> is a
pointer to general information about the International Components for Unicode in Java </p>
<p><a href=""></a> is a pointer to
information on how to make applications global. </p>
<h3><a NAME="SubmittingComments"></a><u>Submitting Comments, Requesting Features and
Reporting Bugs</u></h3>
<p>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>
<p>To submit comments, request features and report bugs, contact us through the <a href=>ICU4J mailing list</a>.<br>
While we are not able to respond individually to each comment, we do review all comments. </p>
<hr size="2" width="100%" align="center">
<p>Copyright © 2001 International Business Machines Corporation and others. All Rights
Reserved. <br>
10275 N De Anza Blvd., Cupertino, CA 95014 <br>
All rights reserved. </p>
<hr size="2" width="100%" align="center">