data-usr/mainpage.txt

   1 /***@mainpage The m17n library documentation
   2
   3 @section what What is the m17n library?
   4
   5 The @e m17n @e library is a multilingual text processing library for
   6 the C language.
   7
   8 <ul>
   9
  10 <li> It is an open source software.
  11
  12 <li> It is for any GNU/Linux and Unix applications/libraries.
  13
  14 <li> It realizes multilingualization of many aspects of
  15 applications/libraries.
  16
  17 </ul>
  18
  19 The word "m17n" is an abbreviation of "multilingualization".
  20
  21 The m17n library provides following facilities to handle
  22 multilingual text.
  23
  24 <ul>
  25
  26 <li> @e M-text: A data structure for a multilingual text.  It is
  27 basically a string but with attributes called text property, and
  28 is designed to substitute for the C string.
  29
  30 <li> Functions for creating and processing M-texts.
  31
  32 <li> Functions for converting M-texts from/to strings encoded in
  33 various existing formats.
  34
  35 <li> A huge character space, which contains all the Unicode
  36 characters and more non-Unicode characters.
  37
  38 <li> @e Chartable: A data structure that contains per-character
  39 information efficiently.
  40
  41 <li> Functions for inputting and displaying M-text on a window
  42 system.
  43
  44 </ul>
  45
  46 @section usage How to use it?
  47
  48 Just include <m17n.h> in your program, and link it with the m17n
  49 library by -lm17n.  See the documentation of the module \link
  50 m17nIntro Introduction \endlink for the detail.
  51
  52 @section contact Contact us:
  53
  54 Global IT Security Group\n
  55 Information Technology Research Institute\n
  56 Institute of Advanced Industrial Science and Technology
  57
  58 E-mail: mule-aist@m17n.org
  59
  60 */
  61 ////