diff --git a/icu4j/readme.html b/icu4j/readme.html index d5944e8cf01..056bd377fe3 100644 --- a/icu4j/readme.html +++ b/icu4j/readme.html @@ -3,527 +3,166 @@ - - - - -ReadMe for ICU - - - - - - - +ReadMe for ICU4J - -
+

ReadMe: International Components for Unicode for Java

-

Version: February 1, 2000

-
+

Version: April 13, 2000


-

COPYRIGHT:
Copyright (c) 2000 International Business Machines Corporation and others. All Rights Reserved.

-

-
-
 
-

-  

Contents

- -

Introduction

-

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:

-

Your comments are important to making this release successful.  We are committed - to fixing any bugs, and will also use your feedback to help plan future releases.

-

IMPORTANT: Please make sure you - understand the Copyright and License information.
-  
-  

-

What the International Components for Unicode for Java - Contain

-

There are two ways to download the ICU4J releases,

-

For more details on how to download ICU4J directly from the web site, please also see http:/oss.software.ibm.com/developerworks/opensource/icu4j/download/index.html -

-

Below, $Root 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.
-  

-

The following files describe the code drop:
-  
-  

- - - - - - - - - -

readme.html (this - file)

-

describes the - International Components for Unicode for Java

-

license.html

-

contains IBM's - public license

-
-

The source directories mirror package structure of the code.  The following - directories contain source code and data files:
-  
-  

- - - - - - - - - - - - - - - - - - - - + + + + + + + + + +

$Root/src/data/

-

Various - data files used to generate ICU4J classes.  Most of the files contain Unicode - information that is available from http://www.unicode.org/.  - Used only by tools in the src/com/ibm/tools.

-

$Root/src/com/ibm/demo

-

Demonstration - applications and Applets.

-

$Root/src/com/ibm/test

-

Tests - for various ICU4J components.. For information about running the tests, see $Root/docs/com/ibm/test/topleveltest/TestAll.html.

-

$Roo/src/com/ibm/tools

-

Various - tools used to generate ICU4J classes.  $Root/src/com/ibm/tools

-

$Root/src/com/ibm/text

-

The - following components: 

+ +

Contents

+ + + +

Introduction

+ +

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

    +
  • International Calendars – Arabic, Buddhist, Hebrew, Japanese
  • +
  • Unicode Normalization – Canonical text representation for W3C
  • +
  • Number Format Enhancements – Scientific Notation, Spelled-out, ...
  • +
  • Enhanced word-break detection – Rule-based, supports Thai
  • +
  • Unicode Text Searching – Efficient multi-lingual searching
  • +
  • Unicode Text Compression – 2:1 compression on English Unicode text
  • +
+ +

Your comments are important to making this release successful.  We are committed +to fixing any bugs, and will also use your feedback to help plan future releases.

+ +

IMPORTANT: Please make sure you understand the Copyright +and License information.

+ +

What the International Components for Unicode for Java +Contains

+ +

There are two ways to download the ICU4J releases, + +

    +
  • Official Release Snapshot:
    + 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.  These versions are tested + more thoroughly than day-to-day development builds, and they are packaged in zip and tar + files for convenient download.  These packaged files can be found at http://oss.software.ibm.com/developerworks/opensource/icu4j/download/index.html. +
    + If packaged snapshot is named ICU4JXXXXXX.zip , XXXXXX is the release version + number.
    + Please unzip this file.  It will re-construct the source directory.
  • +
+ +
    +
  • CVS Source Repository:
    + 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:
    +
      +
    • WebCVS:
      + 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.
      +
    • +
    • WinCVS:
      + 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:
        +
      1. Install the WinCVS client, which you can download from the WinCVS home page.
      2. +
      3. In the WinCVS preferences, specify your CVSRoot to be + ":pserver:anoncvs@oss.software.ibm.com:/usr/cvs/icu4j"
        + with the password "anoncvs". To enter the CVSRoot value, select + "Preferences" from the "Cvs Admin" pull-down menu.    + Authentication should be set to "'passwd' file on the cvs server".
      4. +
      5. To "extract" the most recent version of ICU4J, select "Checkout + module" from the "Cvs Admin" menu. Specify "icu4j" for the module + name.
        +
      6. +
      +
    • +
    • CVS command line:
      + 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:
      export CVSROOT=:pserver:anoncvs@oss.software.ibm.com:/usr/cvs/icu4j 
      +cvs login CVS password: anoncvs 
      +cvs checkout icu4j 
      +cvs logout
      +
    • +
    +
  • +
+ +

For more details on how to download ICU4J directly from the web site, please also see http:/oss.software.ibm.com/developerworks/opensource/icu4j/download/index.html +

+ +

Below, $Root 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.

+ +

The following files describe the code drop:

+ + + + + + + + + + +
readme.html (this file)describes the International Components for Unicode for Java
license.htmlcontains IBM's public license
+ +

The source directories mirror package structure of the code.  The following +directories contain source code and data files:

+ + + + + + + + + + + + + + + + + + + + + - - - - - - - - - -
$Root/src/data/Various data files used to generate ICU4J classes.  Most of the files + contain Unicode information that is available from http://www.unicode.org/.  + Used only by tools in the src/com/ibm/tools.
$Root/src/com/ibm/demoDemonstration applications and Applets.
$Root/src/com/ibm/testTests for various ICU4J components.. For information about running the + tests, see $Root/docs/com/ibm/test/topleveltest/TestAll.html.
$Roo/src/com/ibm/toolsVarious tools used to generate ICU4J classes.  $Root/src/com/ibm/tools
$Root/src/com/ibm/textThe following components: 
  • RuleBasedBreakIterator
  • DictionaryBasedBreakIterator
  • Transliterator
  • @@ -531,139 +170,181 @@ Reserved.

  • BigNumberFormat
  • StringSearch
  • Unicode compression
  • -

$Root/src/com/ibm/util

-

Calendars - and Holidays

-

$Root/build

-

Additional - classes needed to build using Ant

-
-

The following directories are populated when you've built everything:
-  
-  

- - - - - - - - - -

$Root/classes/

-

contains all class - files

-

$Root/docs

-

contains JavaDoc for - all packages

-
-

API Overview

-

The complete API documentation is available on the ICU4J web sight:
-  

- -
  • Complete index
  • -
  • International - Calendars – Islamic, Buddhist, Hebrew, Japanese
  • -
  • Unicode Normalization – Canonical - text representation for W3C
  • -
  • Number Format Enhancements – - Scientific Notation, Spelled-out, ...
  • -
  • Enhanced word-break detection – - Rule-based, supports Thai
  • -
  • Unicode Text Searching – Efficient - multi-lingual searching
  • -
  • Unicode - Text Compression & Decompression – 2:1 - compression on English Unicode text
  • -
     
    -

    -  

    Platform Dependencies

    -

    Parts of ICU4J depend on functionality that is only available in Java2 (JDk1.2) or - later, although some components work under 1.1.  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.  Currently 1.1.x is unsupported and - untested and you use the components on a 1.1.x system at your own risk.

    -

    How to Install/Build using Javac

    -

    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.

    -

    Create a folder named "classes" in the icu4j forlder.

    -

    Run the buildall.bat script by typing "buildall" (or "buildall.bat" - from Unix) to build all the classes in ICU4J.  Note that the script simply calls - javac so the java compiler must be in your path for the script to work correctly.  - The resulting class files will be put in the "classes" directory.

    -

    How to Install/Build using Ant

    -

    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.

    -

    Ant is a Java based build system developed for the Jakarta (part of Apache) - project.  It can be downloaded from the Jakarta websight at: http://jakarta.apache.org/downloads/binindex.html.  - Download the latest Jakarta-tools archive (http://jakarta.apache.org/builds/tomcat/release/v3.1_beta_1/bin/jakarta-ant.zip). -

    -

    The steps for installing Ant are:
    - Move the Jakarta-ant.zip file into the root ICU4J folder (at the same level with the src - and build folders).
    - Unzip the tools into the ICU4J root folder, type "unzip -a jakarta-ant.zip"
    - Type "Build all" or "Build.sh all" under Unix.

    -

    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.

    -

    At this point it is probably a good idea to run all the tests by typeing "java - -classpath classes com.ibm.test.topleveltest.TestAll".

    -

    Where to Find More Information

    -

    http://oss.software.ibm.com/icu4j is a - pointer to general information about the International Components for Unicode in Java

    -

    http://www.ibm.com/unicode is a pointer to - information on how to make applications global.
    -  

    -

    Submitting Comments, Requesting Features and - Reporting Bugs

    -

    To submit comments, request features and report bugs, please contact us.  While we - are not able to respond individually to each comment, we do review all comments. Send - Internet email to icu4j@oss.software.ibm.com. -

    -

    -

    Copyright © 2000 International Business Machines Corporation and others. All - Rights Reserved.
    - IBM Center for Java Technology Silicon Valley,
    - 10275 N De Anza Blvd., Cupertino, CA 95014
    - All rights reserved.

    -

    -
    + +
    $Root/src/com/ibm/utilCalendars and Holidays
    $Root/buildAdditional classes needed to build using Ant
    + +

    The following directories are populated when you've built everything:

    + + + + + + + + + + +
    $Root/classes/contains all class files
    $Root/docscontains JavaDoc for all packages
    + +

    API Overview

    + +

    The complete API documentation is available on the ICU4J web site: + +

    + +

    Platform Dependencies

    + +

    Parts of ICU4J depend on functionality that is only available in Java2 (JDk1.2) or +later, although some components work under 1.1.  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.  Currently 1.1.x is unsupported and +untested and you use the components on a 1.1.x system at your own risk.

    + +

    How to Install and Build

    + +

    To install ICU4J, simply place the prebuilt jar file icu4j.jar on your +Java CLASSPATH.  No other files are needed.

    + +

    The prerequisites for building ICU4J are a working JDK and the Ant build system: + +

    + +

    Once Ant is installed, building is just a matter of typing ant in the +ICU4J root directory. This causes the Ant build system to perform a build as specified by +the file build.xml, 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.

    + +
    +
    F:\icu4j>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
    +
    + +

    Current targets that you can give after ant:

    +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    allBuild all targets.
    coreBuild the main class files in the subdirectory classes. If no target + is specified, core is assumed.
    testsBuild the test class files.
    demosBuild the demos.
    toolsBuild the tools.
    docsRun javadoc over the main class files, generating an HTML documentation tree in the + subdirectory docs.
    jarCreate a jar archive icu4j.jar in the root ICU4J directory containing + the main class files.
    cleanRemove all built targets, leaving the source.
    + +

    For more information, read the Ant documentation and the build.xml +file.

    + +

    After doing a build it is a good idea to run all the tests by typeing "java +-classpath classes com.ibm.test.topleveltest.TestAll".

    + +

    (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 "buildall.bat" +exists to get you started if you're really allergic to build systems. You may have to +create destination directories.)

    + +

    Where to Find More Information

    + +

    http://oss.software.ibm.com/icu4j is a +pointer to general information about the International Components for Unicode in Java

    + +

    http://www.ibm.com/unicode is a pointer to +information on how to make applications global.

    + +

    Submitting Comments, Requesting Features and +Reporting Bugs

    + +

    To submit comments, request features and report bugs, please contact us.  While we +are not able to respond individually to each comment, we do review all comments. Send +Internet email to icu4j@oss.software.ibm.com. +

    + +
    + +

    Copyright © 2000 International Business Machines Corporation and others. All Rights +Reserved.
    +IBM Center for Java Technology Silicon Valley,
    +10275 N De Anza Blvd., Cupertino, CA 95014
    +All rights reserved.

    + +