mainpage.txt

   1 /* -*- coding: utf-8; -*- */
   2 /***en @mainpage The m17n Library Documentation */
   3 /***ja @mainpage m17n ライブラリ */
   4
   5 /***en @section what What is the m17n library?
   6
   7 The @e m17n @e library is a multilingual text processing library for
   8 the C language.
   9
  10 <ul>
  11
  12 <li> It is a free and open source software.
  13
  14 <li> It is for any GNU/Linux and Unix applications/libraries.
  15
  16 <li> It realizes multilingualization of many aspects of
  17 applications/libraries.
  18
  19 </ul>
  20
  21 The word "m17n" is an abbreviation of "multilingualization".
  22
  23 The m17n library provides following facilities to handle
  24 multilingual text.
  25
  26 <ul>
  27
  28 <li> @e M-text: A data structure for a multilingual text.  It is
  29 basically a string but with attributes called text property, and
  30 is designed to substitute for the C string.  It is the most important
  31 object of the m17n library.
  32
  33 <li> Functions for creating and processing M-texts.
  34
  35 <li> Functions for converting M-texts from/to strings encoded in
  36 various existing formats.
  37
  38 <li> A huge character space, which contains all the Unicode
  39 characters and more non-Unicode characters.
  40
  41 <li> @e Chartable: A data structure that contains per-character
  42 information efficiently.
  43
  44 <li> Functions for inputting and displaying M-texts on a window
  45 system.
  46
  47 </ul>
  48 */
  49 /***ja @section what m17n ライブラリとは?
  50
  51 @e m17nライブラリ は C 言語用の多言語文書処理ライブラリです。
  52
  53 <ul>
  54
  55 <li> 自由公開ソフトウェアです。
  56
  57 <li> GNU/Linux と Unix のアプリケーションやライブラリから利用できます。
  58
  59 <li> アプリケーションやライブラリのさまざまな側面で、多言語化を実現し
  60 ます。
  61
  62 </ul>
  63
  64 "m17n" とは "multilingualization" の省略形です。
  65
  66 m17n ライブラリは多言語を扱うため、以下の機能を提供します。
  67
  68 <ul>
  69
  70 <li> @e M-text: 多言語テキスト用のデータ構造。基本的には文字列であるが、
  71 テキストプロパティと呼ばれる属性が付いており、C の文字列の代わりになる
  72 よう設計されている。m17n ライブラリで最も重要なオブジェクト。
  73
  74 <li> M-text を作ったり取り扱ったりするための関数。
  75
  76 <li> M-text と既存のフォーマットでコード化された文字列との間の変換を行
  77 う関数。
  78
  79 <li> 巨大な文字空間。 Unicode 文字すべてとそれ以上の数の非 Unicode 文
  80 字を含むことができる。
  81
  82 <li> @e 文字テーブル: 文字毎の情報を効率的に保持するデータ構造。
  83
  84 <li>  M-text をウィンドウシステム上で入力／表示する関数。
  85
  86 </ul>
  87 */
  88 /***en @section usage How to use it?
  89
  90 Simply include <m17n<EM></EM>.h> in your program, and link it with the m17n
  91 library by -lm17n.  See @ref m17nIntro for the detail.  */
  92
  93 /***ja @section usage 利用方法
  94
  95 <m17n<EM></EM>.h> をプログラムに include し、-lm17n で m17n ライブラリ
  96 とリンクしてください。 @ref m17nIntro を参照。  */
  97
  98 /***en @section extralib External libraries and data
  99
 100 The m17n library utilizes these external libraries.  They are not
 101 mandatory but several functions of the m17n library depend on them.
 102
 103 <ul>
 104 <li> m17n-db -- http://www.m17n.org/m17n-lib/download/m17n-db-1.2.0.tar.gz
 105
 106      Used by @ref m17nShell and @ref m17nGUI.
 107
 108 <li> libxml2 -- http://xmlsoft.org/
 109
 110      Used by the functions mtext_serialize () and mtext_deserialize ().
 111      Those functions return NULL when libxml2 is not available,
 112
 113 <li> fribidi -- http://fribidi.sourceforge.net/
 114
 115      Used for BIDI processing.  If it is not available, the rendering
 116      engine of the m17n library can't handle such script as Arabic and
 117      Hebrew correctly.
 118
 119 <li> freetype -- http://www.freetype.org/
 120
 121      Used for handling local fonts.
 122
 123 <li> fontconfig -- http://nexp.cs.pdx.edu/fontconfig/
 124
 125      Used for handling local fonts supported by the freetype library.
 126
 127 <li> fontconfig -- http://freedesktop.org/Software/fontconfig
 128
 129      Used for finding local fonts in combination with Xft.
 130
 131 <li> xft -- http://freedesktop.org/Software/Xft
 132
 133      Used for drawing text with local fonts by X Render Extension of X
 134      server in combination with fontconfig.
 135
 136 <li> GD
 137
 138      Used for rendering text with local fonts on bitmap/pixmap.
 139
 140 <li> libotf  -- http://www.m17n.org/libotf/
 141
 142      Used for handling OpenTypee fonts in combination with freetype
 143      and Xft.
 144
 145 <li> anthy -- http://anthy.sourceforge.jp/
 146
 147      Used for the Japanese input method ja-anthy.mim.
 148
 149 <li> wordcut -- http://thaiwordseg.sourceforge.net/
 150
 151      Used for finding Thai word boundary in the example program
 152      example/linebreak.c.
 153
 154 </ul>
 155
 156 */
 157 /***ja @section extralib 外部ライブラリ／データ
 158
 159 m17n ライブラリは以下の外部ライブラリを利用しています。必須ではありま
 160 せんが、m17n ライブラリの幾つかの関数はこれらに依存しています。
 161
 162 <ul>
 163 <li> m17n-db -- http://www.m17n.org/m17n-lib/download/m17n-db-1.2.0.tar.gz
 164
 165      @ref m17nShell と @ref m17nGUI が使います。
 166
 167 <li> libxml2 -- http://xmlsoft.org/
 168
 169      関数 mtext_serialize () と mtext_deserialize () が使います。
 170      libxml2 が利用できない時には、これらの関数は NULL を返します。
 171
 172
 173 <li> fribidi -- http://fribidi.sourceforge.net/
 174
 175      BIDI 処理に使います。利用できない時は、m17n ライブラリの表示エン
 176      ジンは Arabic やHebrew などのスクリプトを正しく処理できません。
 177
 178 <li> freetype -- http://www.freetype.org/
 179
 180      ローカルフォントの処理に使います。
 181
 182 <li> fontconfig -- http://nexp.cs.pdx.edu/fontconfig/
 183
 184      Xft と共に、ローカルフォントの検索に使います。
 185
 186 <li> xft -- http://freedesktop.org/Software/Xft
 187
 188      fontconfig と共に X サーバの XRender 拡張を利用してテキストをロー
 189      カルフォントで表示するために使います。
 190
 191 <li> GD
 192      テキストをローカルフォントで bitmap/pixmap 上に表示するのに使いま
 193      す。
 194
 195 <li> libotf  -- http://www.m17n.org/libotf/
 196
 197      freetype と共に OpenType フォントの処理に使います。
 198
 199 <li> anthy -- http://anthy.sourceforge.jp/
 200
 201      日本語入力メソッド ja-anthy.mim が使います。
 202
 203 <li> wordcut -- http://thaiwordseg.sourceforge.net/
 204
 205      プログラム例 example/linebreak.c 中でタイ語の語の境界を見つけるた
 206      めに使っています。
 207
 208 </ul>
 209 */
 210
 211 /***en @section contact Contact us:
 212
 213 Global IT Security Group\n
 214 National Information Technology Research Institute\n
 215 Institute of Advanced Industrial Science and Technology
 216
 217 Web: http://www.m17n.org/m17n-lib/
 218
 219 Bug report: m17n-lib-bug@m17n.org
 220
 221 Mailing lists: http://www.m17n.org/m17n-lib/mailinglist.html
 222
 223 */
 224 /***ja @section contact 連絡先:
 225
 226 独立行政法人 産業技術総合研究所\n
 227 情報技術研究部門\n
 228 グローバル IT セキュリティグループ
 229
 230 Web: http://www.m17n.org/m17n-lib/
 231
 232 バグレポート: m17n-lib-bug@m17n.org
 233
 234 メイリングリスト: http://www.m17n.org/m17n-lib-ja/mailinglist.htm
 235
 236 */
 237 /***en @section ack Acknowledgements */
 238 /***ja @section ack 謝辞 */
 239 /***
 240 Special thanks to:
 241
 242 <ul>
 243
 244 <li> Dimitri van Heesch <dimitri@stack.nl>
 245
 246 Author of Doxygen <http://www.stack.nl/~dimitri/doxygen/>.  Without
 247 this tool, it would have been impossible to create this documentation.
 248
 249 <li> Information-technology Promotion Agency (IPA), Japan
 250
 251 Writing this documentation was partially funded by
 252 Information-technology Promotion Agency (IPA)
 253 <http://www.ipa.go.jp/about/english/index.html> in fiscal year 2001.
 254
 255 </ul>
 256 */
 257
 258 /***
 259 @htmlonly
 260 <hr>
 261 Copyright (C) 2001 Information-technology Promotion Agency (IPA)<p>
 262 Copyright (C) 2001-2006
 263   National Institute of Advanced Industrial Science and Technology (AIST)<p>
 264
 265 Permission is granted to copy, distribute and/or modify this document
 266 under the terms of the GNU Free Documentation License, Version 1.2 or
 267 any later version published by the Free Software Foundation; with no
 268 Invariant Section, Front-Cover Texts "The m17n library documentation",
 269 and no Back-Cover Texts.  A copy of the license is included in the
 270 appendix entitled "GNU Free Documentation License".
 271 @endhtmlonly
 272 */