1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/intl/icu/source/extra/scrptrun/readme.html Wed Dec 31 06:09:35 2014 +0100
1.3 @@ -0,0 +1,68 @@
1.4 +<!doctype html public "-//w3c//dtd html 4.0 transitional//en">
1.5 +<html>
1.6 +<head>
1.7 + <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
1.8 + <meta name="Copyright" content="Copyright (c) 2002, International Business Machines Corporation and others. All Rights Reserved.">
1.9 + <meta name="Author" content="Eric Mader">
1.10 + <meta name="GENERATOR" content="Mozilla/4.72 [en] (Windows NT 5.0; U) [Netscape]">
1.11 + <title>ScriptRun readme</title>
1.12 +</head>
1.13 +<body>
1.14 +
1.15 +<h2>
1.16 +What is scrptrun and srtest?</h2>
1.17 +The ICU LayoutEngine must be called with text in a single script. scrptrun.h
1.18 +and scrptrun.cpp implement the ScriptRun class, which can be used to find
1.19 +runs of text that is in a single script. It uses a basic iteration interface.
1.20 +<p>srtest is a little program that tests ScriptRun. You can use it as an
1.21 +example of how to use ScriptRun. Here's what the output should look like:
1.22 +<blockquote><font face="Courier New,Courier"><font size=-1>Script 'DEVANAGARI'
1.23 +from 0 to 9.</font></font>
1.24 +<br><font face="Courier New,Courier"><font size=-1>Script 'ARABIC' from
1.25 +9 to 17.</font></font>
1.26 +<br><font face="Courier New,Courier"><font size=-1>Script 'CYRILLIC' from
1.27 +17 to 25.</font></font>
1.28 +<br><font face="Courier New,Courier"><font size=-1>Script 'LATIN' from
1.29 +25 to 33.</font></font>
1.30 +<br><font face="Courier New,Courier"><font size=-1>Script 'HAN' from 33
1.31 +to 35.</font></font>
1.32 +<br><font face="Courier New,Courier"><font size=-1>Script 'HIRAGANA' from
1.33 +35 to 41.</font></font>
1.34 +<br><font face="Courier New,Courier"><font size=-1>Script 'KATAKANA' from
1.35 +41 to 45.</font></font>
1.36 +<br><font face="Courier New,Courier"><font size=-1>Script 'DESERET' from
1.37 +45 to 53.</font></font></blockquote>
1.38 +
1.39 +<h2>
1.40 +How do I build scrptrun and srtest?</h2>
1.41 +To use the ScriptRun class in a Windows application, just include scrptrun.h
1.42 +and scrptrun.cpp right out of the <icu>\source\extra\scrptrun directory
1.43 +into your project. You'll also need to add the <icu>\source]extra\scrptrun
1.44 +directory to the "Additional include directories" section of the "Preprocessor"
1.45 +category on the "C/C++" tab in the project settings.
1.46 +<p>On UNIX systems the simplest thing to do is to just copy scrptrun.h
1.47 +and scrptrun.cpp into your source directory. If you want to use them from
1.48 +<icu>/source/extra/scrpturn, it's a bit trickier: the default dependency
1.49 +rules don't work on source files in a different directory. You need to
1.50 +add separate dependency rules for scrptrun.o and scrptrun.d. See <icu>/source/samples/layout/Makefile.in
1.51 +for an example of how to do this. You'll also have to add -I$(top_srcdir)/extra/scrptrun
1.52 +to your compiler flags so that the compiler can find scrptrun.h. If your
1.53 +application has to build on multiple UNIX platforms, it might be difficult
1.54 +to wirte dependency rules that will work correctly on all platforms. In
1.55 +that case, you're probably better off copying the scrpturn files to your
1.56 +source directory.
1.57 +<p>Building srtest is easy, on Windows build the srtest workspace in <icu>\source\extra\scrptrun.
1.58 +On UNIX, connect to <top-build-dir>/extra/scrptrun and do "make all"
1.59 +<h2>
1.60 +Notes</h2>
1.61 +
1.62 +<ul>
1.63 +<li>
1.64 +ScriptRun is based on <a href="http://www.unicode.org/unicode/reports/tr24/">Unicode
1.65 +Technical Report #24</a> but the implementation is not complete. In particular
1.66 +the support for paired punctuation is only a prototype. A complete implementation
1.67 +will be added to ICU in the future.</li>
1.68 +</ul>
1.69 +
1.70 +</body>
1.71 +</html>
