X-Git-Url: http://git.indexdata.com/?a=blobdiff_plain;f=doc%2Fyaz-icu-man.xml;h=d0fd43c414425ad3986131fa60faf071f3f6b085;hb=2bfb0b990bbbe0f9c5ef9e78b094a2063bc45f33;hp=110bd6554cdb62f5e79a2184930b2775cd245733;hpb=6135f5d048a8bbbc29d14deb9512202c777bd6bc;p=yaz-moved-to-github.git

diff --git a/doc/yaz-icu-man.xml b/doc/yaz-icu-man.xml
index 110bd65..d0fd43c 100644
--- a/doc/yaz-icu-man.xml
+++ b/doc/yaz-icu-man.xml
@@ -1,5 +1,5 @@
-<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN"
- "http://www.oasis-open.org/docbook/xml/4.1/docbookx.dtd"
+<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V4.4//EN"
+ "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd"
 [
      <!ENTITY % local SYSTEM "local.ent">
      %local;
@@ -12,13 +12,15 @@
  <refentryinfo>
   <productname>YAZ</productname>
   <productnumber>&version;</productnumber>
+  <info><orgname>Index Data</orgname></info>
  </refentryinfo>
- 
+
  <refmeta>
   <refentrytitle>yaz-icu</refentrytitle>
   <manvolnum>1</manvolnum>
+  <refmiscinfo class="manual">Commands</refmiscinfo>
  </refmeta>
- 
+
  <refnamediv>
   <refname>yaz-icu</refname>
   <refpurpose>YAZ ICU utility</refpurpose>
@@ -27,19 +29,30 @@
  <refsynopsisdiv>
   <cmdsynopsis>
    <command>yaz-icu</command>
-   <arg choice="opt" rep="repeat">commands</arg>
    <arg>-c <replaceable>config</replaceable></arg>
    <arg>-p <replaceable>opt</replaceable></arg>
    <arg>-s</arg>
    <arg>-x</arg>
+   <arg choice="opt">infile</arg>
   </cmdsynopsis>
  </refsynopsisdiv>
- 
+
  <refsect1><title>DESCRIPTION</title>
   <para>
-   <command>yaz-icu</command> is utility which demonstrates 
+   <command>yaz-icu</command> is a utility which demonstrates
    the ICU chain module of yaz. (<filename>yaz/icu.h</filename>).
   </para>
+  <para>
+    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 <literal>-c</literal> which specifies
+    the configuration to be used. The input file is read from standard
+    input or from a file if <literal>infile</literal> is specified.
+  </para>
+  <para>
+    The utility may also show ICU information. This is triggered by
+    option <literal>-p</literal>.
+  </para>
  </refsect1>
 
  <refsect1><title>OPTIONS</title>
@@ -57,11 +70,11 @@
     <listitem><para>
       Specifies extra information to be printed about the ICU system.
       If <replaceable>type</replaceable> is <literal>c</literal>
-      then ICU converters are printed. 
-      If <replaceable>type</replaceable> is <literal>l</literal>
-      available locales are printed.
-      If <replaceable>type</replaceable> is <literal>t</literal>
-      available transliterators are printed.
+      then ICU converters are printed.
+      If <replaceable>type</replaceable> is <literal>l</literal>,
+      then available locales are printed.
+      If <replaceable>type</replaceable> is <literal>t</literal>,
+      then available transliterators are printed.
      </para></listitem>
    </varlistentry>
 
@@ -85,7 +98,7 @@
  </refsect1>
  <refsect1><title>ICU chain configuration</title>
   <para>
-   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.
   </para>
   <para>
@@ -103,18 +116,18 @@
   </para>
   <para>
    The following conversion elements are available:
-   
+
    <variablelist>
     <varlistentry>
      <term>casemap</term>
      <listitem><para>
-       Converts case and rule specifies how:
+       Converts case (and rule specifies how):
 
        <variablelist>
 	<varlistentry>
 	 <term>l</term>
 	 <listitem>
-	  <para>Lowercase using ICU function u_strToLower. </para>
+	  <para>Lower case using ICU function u_strToLower. </para>
 	 </listitem>
 	</varlistentry>
 
@@ -124,11 +137,11 @@
 	  <para>Upper case using ICU function u_strToUpper.</para>
 	 </listitem>
 	</varlistentry>
-	
+
 	<varlistentry>
 	 <term>t</term>
 	 <listitem>
-	  <para>To title using UCU function u_strToTitle.</para>
+	  <para>To title using ICU function u_strToTitle.</para>
 	 </listitem>
 	</varlistentry>
 
@@ -138,7 +151,7 @@
 	  <para>Fold case using ICU function u_strFoldCase.</para>
 	 </listitem>
 	</varlistentry>
-	
+
        </variablelist>
       </para></listitem>
     </varlistentry>
@@ -151,18 +164,28 @@
        using function icu_chain_token_display (<filename>yaz/icu.h</filename>).
       </para></listitem>
     </varlistentry>
-    
+
     <varlistentry>
      <term>transform</term>
      <listitem><para>
-       Specifies an ICU transform rule. The rule attribute is the
-       custom transformation rule to be used. This is a text based format
-       which is offered by the ICU transform system. See
-       <ulink url="&url.icu.transform;">ICU Transforms</ulink> for
+       Specifies an ICU transform rule using a transliterator
+       Identifier.
+       The rule attribute is the transliterator Identifier.
+       See  <ulink url="&url.icu.transform;">ICU Transforms</ulink> for
        more information.
       </para></listitem>
     </varlistentry>
-    
+
+    <varlistentry>
+     <term>transliterate</term>
+     <listitem><para>
+       Specifies a rule-based transliterator.
+       The rule attribute is the custom transformation rule to be used.
+       See <ulink url="&url.icu.transform;">ICU Transforms</ulink> for
+       more information.
+      </para></listitem>
+    </varlistentry>
+
     <varlistentry>
      <term>tokenize</term>
      <listitem><para>
@@ -183,7 +206,7 @@
 	  <para>Sentence. ICU: UBRK_SENTENCE.</para>
 	 </listitem>
 	</varlistentry>
-	
+
 	<varlistentry>
 	 <term>w</term>
 	 <listitem>
@@ -208,9 +231,19 @@
        </variablelist>
       </para></listitem>
     </varlistentry>
-    
+
+    <varlistentry>
+     <term>join</term>
+     <listitem>
+      <para>
+       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.
+      </para>
+     </listitem>
+    </varlistentry>
    </variablelist>
-   
+
   </para>
  </refsect1>
  <refsect1><title>EXAMPLES</title>
@@ -226,6 +259,7 @@
   <transform rule="[:Control:] Any-Remove"/>
   <tokenize rule="w"/>
   <transform rule="[[:WhiteSpace:][:Punctuation:]] Remove"/>
+  <transliterate rule="xy > z;"/>
   <display/>
   <casemap rule="l"/>
 </icu_chain>
@@ -251,15 +285,7 @@
 
 <!-- Keep this comment at the end of the file
 Local variables:
-mode: sgml
-sgml-omittag:t
-sgml-shorttag:t
-sgml-minimize-attributes:nil
-sgml-always-quote-attributes:t
-sgml-indent-step:1
-sgml-indent-data:t
-sgml-parent-document:nil
-sgml-local-catalogs: nil
-sgml-namecase-general:t
+mode: nxml
+nxml-child-indent: 1
 End:
 -->