data/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 a free and 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.  It is the most important
  29 object of the m17n library.
  30
  31 <li> Functions for creating and processing M-texts.
  32
  33 <li> Functions for converting M-texts from/to strings encoded in
  34 various existing formats.
  35
  36 <li> A huge character space, which contains all the Unicode
  37 characters and more non-Unicode characters.
  38
  39 <li> @e Chartable: A data structure that contains per-character
  40 information efficiently.
  41
  42 <li> Functions for inputting and displaying M-text on a window
  43 system.
  44
  45 </ul>
  46
  47 @section usage How to use it?
  48
  49 Just include <m17n.h> in your program, and link it with the m17n
  50 library by -lm17n.  See @ref m17nIntro @latexonly
  51 (P.\pageref{group__m17nIntro}) @endlatexonly for the detail.
  52
  53 @section contact Contact us:
  54
  55 Global IT Security Group\n
  56 National Information Technology Research Institute\n
  57 Institute of Advanced Industrial Science and Technology
  58
  59 Web: http://www.m17n.org/m17n-lib/
  60
  61 Bug report: m17n-lib-bug@m17n.org
  62
  63 Mailing list (English): m17n-lib@m17n.org
  64
  65 Mailing list (Japanese): m17n-lib-ja@m17n.org
  66 */
  67 ////