readme.html
1<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
2<html>
3<head>
4<meta name="generator" content=
5"HTML Tidy for Windows (vers 26 April 2007), see www.w3.org">
6<meta http-equiv="Content-Type" content=
7"text/html; charset=us-ascii">
8<meta name="Copyright" content=
9"Copyright (C) 2016 and later: Unicode, Inc. and others. License & terms of use: http://www.unicode.org/copyright.html">
10<!-- meta name="Copyright" content=
11"Copyright (c) 2001-2007, International Business Machines Corporation and others. All Rights Reserved." -->
12<meta name="Author" content="Eric Mader">
13<meta name="GENERATOR" content=
14"Mozilla/4.72 [en] (Windows NT 5.0; U) [Netscape]">
15<title>Readme file for letest and gendata</title>
16</head>
17<body>
18<h2>What are letest and gendata?</h2>
19letest is a test program that you can use to verify the basic
20functionality of the ICU LayoutEngine. It tests the LayoutEngine's
21API and reads an XML file that contains test cases to test some of
22the features of the LayoutEngine. These test cases are not
23comprehensive, but they do test the most important features of
24 the LayoutEngine. When you have successfully run letest, you
25can use the ICU LayoutEngine in you application knowing that the
26basic functionality is working correctly.<br>
27<p>gendata is a program that is used by the ICU team to build the
28file letest.xml which contains the test cases. Unless you have
29changed your copy of the LayoutEngine and want to validate the
30changes on other platforms, there's no reason for you to run this
31program.</p>
32<p>(The ICU team first runs a Windows application which uses the
33ICU LayoutEngine to display the text that letest uses. Once it has
34been verified that the text is displayed correctly, gendata is run
35to produce letest.xml, and then letest is run on Windows to verify
36that letest still works with the new data.)<br></p>
37<h2>How do I build letest?</h2>
38First, you need to build ICU, including the LayoutEngine.
39<p>On Windows, letest is part of the allinone project, so a normal
40build of ICU will also build letest. On UNIX systems, connect to
41<top-build-dir>/test/letest and do "make all" .<br></p>
42<h2>How do I run letest?</h2>
43Before you can run letest, you'll need to get the fonts it uses.
44For legal reasons, we can't include most of them with ICU, but you
45can download them from the web. To do this, you'll need access to a
46computer running Windows. All of the fonts should be stored in
47<icu>/source/test/testdata. Here's how to get the fonts:
48<p>Download a recent version of the Java 2 Platform, Standard
49Edition (J2SE) from <a href=
50"http://java.sun.com/javase/downloads/index.html">java.sun.com</a>.
51Click on the "Download" button for the version of Java that you
52want to download. The page offers both JDKs and JREs. (The JRE is
53sufficient for letest.) The download page will have a link to the
54license agreement. Be sure to read and understand the license
55agreement, and then click on the Accept button. Download the
56package and install it. You'll need one font. On Windows, it will
57be in, for example, "C:\Program Files\Java\jdk1.6.0\jre\lib\fonts".
58The file you want is "LucidaSansRegular.ttf". Copy this file into
59the directory from which you'll run letest.<br></p>
60<p>Next is the Hindi font. Go to the NCST site and download
61<a href="http://tdil.mit.gov.in/download/Raghu.htm">raghu.ttf</a>.
62When you hit the DOWNLOAD button on the page, it will open another
63window which contains a disclaimer and a license agreement. Be sure
64that you understand and agree to all of this before you download
65the font. You can download raghu.ttf into the directory from which
66you'll run letest.<br></p>
67<p>Then download the Thai font. Go to <a href=
68"http://www.into-asia.com/thai_language/thaifont/">into-asia.com</a>
69and click on the link for the Angsana font. This will download a
70.ZIP file. Extract the font file, angsd___.ttf, into the directory
71from which you will run letest.<br></p>
72<p>There's still one more font to get, the Code2000 Unicode font.
73Go to James Kass' <a href="http://www.code2000.net/">Unicode
74Support In Your Browser</a> page and click on the link that says
75"Click Here to download Code2000 shareware demo Unicode font." This
76will download a .ZIP file which contains CODE2000.TTF and
77CODE2000.HTM. Expand this .ZIP file and put the CODE2000.TTF file
78in the directory from which you'll run letest.<br></p>
79<p><span style="font-weight: bold;">Note:</span> The Code2000 font
80is shareware. If you want to use it for longer than a trial period,
81you should send a shareware fee to James. Directions for how to do
82this are in CODE2000.HTM.</p>
83<p>letest.xml references three other fonts:</p>
84<ul>
85<li>ARIALUNI.TTF is Microsoft's Arial Unicode MS font, which is
86distributed with Microsoft Office and is licensed only for use on
87the Windows operating system.</li>
88<li>Devamt.ttf is a proprietary font which cannot be freely
89downloaded.</li>
90<li>TestFont1.otf is included with ICU.</li>
91</ul>
92To run letest type CTRL+F5 in Visual Studio, or "make check" in
93UNIX. If everything's OK you should see something like this:
94<blockquote><tt> /<br>
95 /api/<br>
96 ---[OK] ---/api/ParameterTest<br>
97 ---[OK] ---/api/FactoryTest<br>
98 /layout/<br>
99 ---[OK] ---/layout/AccessTest<br>
100 ---[OK] ---/layout/DataDrivenTest<br>
101 /c_api/<br>
102 ---[OK] ---/c_api/ParameterTest<br>
103 ---[OK] ---/c_api/FactoryTest<br>
104 /c_layout/<br>
105 ---[OK] ---/c_layout/AccessTest<br>
106 ---[OK] ---/c_layout/DataDrivenTest<br>
107<br>
108[All tests passed successfully...]<br>
109Elapsed Time: 00:00:00.351<br></tt></blockquote>
110If letest cannot open a font, it will print a warning message and
111skip the test. letest will also check the version of the font you
112have to make sure it's the same one that was used to generate the
113test case. If the version doesn't match, letest will print a
114warning message and proceed with the test.<br>
115</body>
116</html>
117