X-Git-Url: http://git.indexdata.com/?a=blobdiff_plain;f=doc%2Fyaz-icu-man.xml;h=d0fd43c414425ad3986131fa60faf071f3f6b085;hb=92e9ead954f1292391afde93235f0fd25891da8e;hp=7c2bda54bb65d1af5603a44fb4854cfbb1086eb2;hpb=5b5d2ba5455538ccc356e208476dc7aeb3703421;p=yaz-moved-to-github.git
diff --git a/doc/yaz-icu-man.xml b/doc/yaz-icu-man.xml
index 7c2bda5..d0fd43c 100644
--- a/doc/yaz-icu-man.xml
+++ b/doc/yaz-icu-man.xml
@@ -1,5 +1,5 @@
-
%local;
@@ -12,13 +12,15 @@
YAZ
&version;
+ Index Data
-
+
yaz-icu
1
+ Commands
-
+
yaz-icu
YAZ ICU utility
@@ -27,19 +29,30 @@
yaz-icu
- commands
-c config
-p opt
-s
-x
+ infile
-
+
DESCRIPTION
- yaz-icu is utility which demonstrates
+ yaz-icu is a utility which demonstrates
the ICU chain module of yaz. (yaz/icu.h).
+
+ The utility can be used in two ways. It may read some text
+ using an XML configuration for configuring ICU and show text analysis.
+ This mode is triggered by option -c which specifies
+ the configuration to be used. The input file is read from standard
+ input or from a file if infile is specified.
+
+
+ The utility may also show ICU information. This is triggered by
+ option -p.
+
OPTIONS
@@ -57,11 +70,11 @@
Specifies extra information to be printed about the ICU system.
If type is c
- then ICU converters are printed.
- If type is l
- available locales are printed.
- If type is t
- available transliterators are printed.
+ then ICU converters are printed.
+ If type is l,
+ then available locales are printed.
+ If type is t,
+ then available transliterators are printed.
@@ -85,7 +98,7 @@
ICU chain configuration
- The ICU chain configuration speicifies one or more rules to convert
+ The ICU chain configuration specifies one or more rules to convert
text data into tokens. The configuration format is XML based.
@@ -103,18 +116,18 @@
The following conversion elements are available:
-
+
casemap
- Converts case and rule specifies how:
+ Converts case (and rule specifies how):
l
- Lowercase using ICU function u_strToLower.
+ Lower case using ICU function u_strToLower.
@@ -124,11 +137,11 @@
Upper case using ICU function u_strToUpper.
-
+
t
- To title using UCU function u_strToTitle.
+ To title using ICU function u_strToTitle.
@@ -138,7 +151,7 @@
Fold case using ICU function u_strFoldCase.
-
+
@@ -151,7 +164,7 @@
using function icu_chain_token_display (yaz/icu.h).
-
+
transform
@@ -162,7 +175,7 @@
more information.
-
+
transliterate
@@ -172,7 +185,7 @@
more information.
-
+
tokenize
@@ -193,7 +206,7 @@
Sentence. ICU: UBRK_SENTENCE.
-
+
w
@@ -218,9 +231,19 @@
-
+
+
+ join
+
+
+ Joins tokens into one string. The rule attribute is the joining
+ string, which may be empty. The join conversion element was added
+ in YAZ 4.2.49.
+
+
+
-
+
EXAMPLES
@@ -236,7 +259,7 @@
-
+
@@ -262,15 +285,7 @@