*** empty log message ***

[m17n/m17n-docs.git] / data-usr / mainpage.c

diff --git a/data-usr/mainpage.c b/data-usr/mainpage.c
index ad5006a..998b7d7 100644 (file)
--- a/data-usr/mainpage.c
+++ b/data-usr/mainpage.c
@@ -1,35 +1,62 @@
 /***en
     @mainpage The m17n library documentation
 
-    @section sect1 Background
+    @section what What is the m17n library?
 
-    What is the multilingual text processing?
+    The @e m17n @e library is a multilingual text processing library
+    for the C language.
+
+    <ul>
 
-    Why is the m17n library necessary?
+    <li> It is an open source software.
 
-    @section sect2 What is the m17n library?
+    <li> It is for any GNU/Linux and Unix applications/libraries.
 
-    The @e m17n @e library is a multilingual text processing library
-    for the C language.  It provides following facilities to handle
+    <li> It realizes multilingualization of many aspects of
+    applications/libraries.
+ 
+    </ul> 
+
+    The word "m17n" is an abbreviation of "multilingualization".
+
+    The m17n library provides following facilities to handle
     multilingual text.
 
     <ul>
-    <li> @e M-text: A data structure for multilingual text objects.
+
+    <li> @e M-text: A data structure for a multilingual text.  It is
+    basically a string but with attributes called text property, and
+    is designed to substitute for the C string.
 
     <li> Functions for creating and processing M-texts.
 
-    <li> Decoders and encoders for converting M-texts from/to strings
-    encoded in various existing formats.
+    <li> Functions for converting M-texts from/to strings encoded in
+    various existing formats.
 
     <li> A huge character space, which contains all the Unicode
     characters and more non-Unicode characters.
 
     <li> @e Chartable: A data structure that contains per-character
-    information effectively.
+    information efficiently.
+
+    <li> Functions for inputting and displaying M-text on a window
+    system.
 
-    <li> Functions for inputting and displaying M-text.
     </ul>
 
-  */
-////
+    @section usage How to use it?
+
+    Just include <m17n.h> in your program, and link it with the m17n
+    library by -lm17n.  See the documentation of the module \link
+    m17nIntro Introduction \endlink for the detail.
+
+    @section contact Contact us:
 
+    Global IT Security Group\n
+    Information Technology Research Institute\n
+    Institute of Advanced Industrial Science and Technology
+
+    E-mail: mule-aist@m17n.org 
+
+*/
+////