mainpage.txt

   1 /***en
   2 @mainpage The M17N Library Documentation
   3
   4 @section what What is the m17n library?
   5
   6 The @e m17n @e library is a multilingual text processing library for
   7 the C language.
   8
   9 <ul>
  10
  11 <li> It is a free and open source software.
  12
  13 <li> It is for any GNU/Linux and Unix applications/libraries.
  14
  15 <li> It realizes multilingualization of many aspects of
  16 applications/libraries.
  17
  18 </ul>
  19
  20 The word "m17n" is an abbreviation of "multilingualization".
  21
  22 The m17n library provides following facilities to handle
  23 multilingual text.
  24
  25 <ul>
  26
  27 <li> @e M-text: A data structure for a multilingual text.  It is
  28 basically a string but with attributes called text property, and
  29 is designed to substitute for the C string.  It is the most important
  30 object of the m17n library.
  31
  32 <li> Functions for creating and processing M-texts.
  33
  34 <li> Functions for converting M-texts from/to strings encoded in
  35 various existing formats.
  36
  37 <li> A huge character space, which contains all the Unicode
  38 characters and more non-Unicode characters.
  39
  40 <li> @e Chartable: A data structure that contains per-character
  41 information efficiently.
  42
  43 <li> Functions for inputting and displaying M-text on a window
  44 system.
  45
  46 </ul>
  47
  48 @section usage How to use it?
  49
  50 Just include <m17n.h> in your program, and link it with the m17n
  51 library by -lm17n.  See @ref m17nIntro @latexonly
  52 (P.\pageref{group__m17nIntro}) @endlatexonly for the detail.
  53
  54 @section contact Contact us:
  55
  56 Global IT Security Group\n
  57 National Information Technology Research Institute\n
  58 Institute of Advanced Industrial Science and Technology
  59
  60 Web: http://www.m17n.org/m17n-lib/
  61
  62 Bug report: m17n-lib-bug@m17n.org
  63
  64 Mailing list (English): m17n-lib@m17n.org
  65
  66 Mailing list (Japanese): m17n-lib-ja@m17n.org
  67
  68 @section Acknowledgements
  69
  70 Special thanks to:
  71
  72 <ul>
  73
  74 <li> Dimitri van Heesch <dimitri@stack.nl>
  75
  76 Author of Doxygen (<http://www.stack.nl/~dimitri/doxygen/>).  Without
  77 this tool, it would have been impossible to create this document.
  78
  79 </ul>
  80
  81 */
  82