mainpage.txt

   1 /* -*- coding: euc-jp; -*- */
   2 /***en @mainpage The M17N Library Documentation */
   3 /***ja @mainpage M17N ¥é¥¤¥Ö¥é¥ê */
   4
   5 /***en @section what What is the m17n library? */
   6 /***ja @section what M17N ¥é¥¤¥Ö¥é¥ê¤È¤Ï? */
   7
   8 /***
   9 The @e m17n @e library is a multilingual text processing library for
  10 the C language.
  11
  12 <ul>
  13
  14 <li> It is a free and open source software.
  15
  16 <li> It is for any GNU/Linux and Unix applications/libraries.
  17
  18 <li> It realizes multilingualization of many aspects of
  19 applications/libraries.
  20
  21 </ul>
  22
  23 The word "m17n" is an abbreviation of "multilingualization".
  24
  25 The m17n library provides following facilities to handle
  26 multilingual text.
  27
  28 <ul>
  29
  30 <li> @e M-text: A data structure for a multilingual text.  It is
  31 basically a string but with attributes called text property, and
  32 is designed to substitute for the C string.  It is the most important
  33 object of the m17n library.
  34
  35 <li> Functions for creating and processing M-texts.
  36
  37 <li> Functions for converting M-texts from/to strings encoded in
  38 various existing formats.
  39
  40 <li> A huge character space, which contains all the Unicode
  41 characters and more non-Unicode characters.
  42
  43 <li> @e Chartable: A data structure that contains per-character
  44 information efficiently.
  45
  46 <li> Functions for inputting and displaying M-text on a window
  47 system.
  48
  49 </ul>
  50 */
  51 /***en @section usage How to use it? */
  52 /***ja @section usage ÍøÍÑË¡ */
  53 /***
  54 Just include <m17n.h> in your program, and link it with the m17n
  55 library by -lm17n.  See @ref m17nIntro @latexonly
  56 (P.\pageref{group__m17nIntro}) @endlatexonly for the detail.  */
  57
  58 /***en @section extralib External libraries and data */
  59 /***ja @section extralib ³°Éô¥é¥¤¥Ö¥é¥ê¡¿¥Ç¡¼¥¿ */
  60 /***
  61
  62 The m17n library utilizes these external libraries.  They are not
  63 mandatory but several functions of the m17n library depend on them.
  64
  65 <ul>
  66 <li> m17n-db -- http://www.m17n.org/m17n-db/
  67
  68      Used by @ref m17nShell and @ref m17nGUI.
  69
  70 <li> libxml2 -- http://xmlsoft.org/
  71
  72      Used by the functions mtext_serialize () and mtext_deserialize ().
  73      Those functions return NULL libxml2 is not avairable,
  74
  75 <li> fribidi -- http://fribidi.sourceforge.net/
  76
  77      Used for BIDI processing.  If it is not avairable, the rendering
  78      engine of the m17n library can't handle such scritp as Arabic and
  79      Hebrew correctly.
  80
  81 <li> freetype -- http://www.freetype.org/
  82
  83      Used for handling TrueType and Type1 fonts.
  84
  85 <li> libotf  -- http://www.m17n.org/libotf/
  86
  87      Used for handling OpenTypee fonts.
  88
  89 <li> anthy -- http://anthy.sourceforge.jp/
  90
  91      Used for the Japanese input method ja-anthy.mim.
  92
  93 <li> wordcut -- http://thaiwordseg.sourceforge.net/
  94
  95      Used for finding Thai word boundary in the example program
  96      example/linebreak.c.
  97
  98 </ul>
  99
 100 */
 101
 102 /***en @section contact Contact us: */
 103 /***ja @section contact Ï¢ÍíÀè */
 104 /***
 105 Global IT Security Group\n
 106 National Information Technology Research Institute\n
 107 Institute of Advanced Industrial Science and Technology
 108
 109 Web: http://www.m17n.org/m17n-lib/
 110
 111 Bug report: m17n-lib-bug@m17n.org
 112
 113 Mailing list (English): m17n-lib@m17n.org
 114
 115 Mailing list (Japanese): m17n-lib-ja@m17n.org
 116 */
 117
 118 /***en @section ack Acknowledgements */
 119 /***ja @section ack ¼Õ¼ */
 120 /***
 121 Special thanks to:
 122
 123 <ul>
 124
 125 <li> Dimitri van Heesch <dimitri@stack.nl>
 126
 127 Author of Doxygen <http://www.stack.nl/~dimitri/doxygen/>.  Without
 128 this tool, it would have been impossible to create this documentation.
 129
 130 <li> Information-technology Promotion Agency (IPA), Japan
 131
 132 Writing this documentation was partially funded by
 133 Information-technology Promotion Agency (IPA)
 134 <http://www.ipa.go.jp/about/english/index.html> in fiscal year 2001.
 135
 136 </ul>
 137 */
 138
 139 /***
 140 @htmlonly
 141 <hr>
 142 Copyright (C) 2001 Information-technology Promotion Agency (IPA)<p>
 143 Copyright (C) 2001-2004
 144   National Institute of Advanced Industrial Science and Technology (AIST)<p>
 145
 146 Permission is granted to copy, distribute and/or modify this document
 147 under the terms of the GNU Free Documentation License, Version 1.2 or
 148 any later version published by the Free Software Foundation; with no
 149 Invariant Section, Front-Cover Texts "The m17n library documentation",
 150 and no Back-Cover Texts.  A copy of the license is included in the
 151 appendix entitled "GNU Free Documentation License".
 152 @endhtmlonly
 153 */