1 /* -*- coding: utf-8; -*- */
2 /***en @mainpage The m17n Library Documentation */
3 /***ja @mainpage m17n ライブラリ */
5 /***en @section what What is the m17n library?
7 The @e m17n @e library is a multilingual text processing library for
12 <li> It is a free and open source software.
14 <li> It is for any GNU/Linux and Unix applications/libraries.
16 <li> It realizes multilingualization of many aspects of
17 applications/libraries.
21 The word "m17n" is an abbreviation of "multilingualization".
23 The m17n library provides following facilities to handle
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.
33 <li> Functions for creating and processing M-texts.
35 <li> Functions for converting M-texts from/to strings encoded in
36 various existing formats.
38 <li> A huge character space, which contains all the Unicode
39 characters and more non-Unicode characters.
41 <li> @e Chartable: A data structure that contains per-character
42 information efficiently.
44 <li> Functions for inputting and displaying M-texts on a window
49 /***ja @section what m17n ライブラリとは?
51 @e m17nライブラリ は C 言語用の多言語文書処理ライブラリです。
57 <li> GNU/Linux と Unix のアプリケーションやライブラリから利用できます。
59 <li> アプリケーションやライブラリのさまざまな側面で、多言語化を実現し
64 "m17n" とは "multilingualization" の省略形です。
66 m17n ライブラリは多言語を扱うため、以下の機能を提供します。
70 <li> @e M-text: 多言語テキスト用のデータ構造。基本的には文字列であるが、
71 テキストプロパティと呼ばれる属性が付いており、C の文字列の代わりになる
72 よう設計されている。m17n ライブラリで最も重要なオブジェクト。
74 <li> M-text を作ったり取り扱ったりするための関数。
76 <li> M-text と既存のフォーマットでコード化された文字列との間の変換を行
79 <li> 巨大な文字空間。 Unicode 文字すべてとそれ以上の数の非 Unicode 文
82 <li> @e 文字テーブル: 文字毎の情報を効率的に保持するデータ構造。
84 <li> M-text をウィンドウシステム上で入力/表示する関数。
88 /***en @section usage How to use it?
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. */
93 /***ja @section usage 利用方法
95 <m17n<EM></EM>.h> をプログラムに include し、-lm17n で m17n ライブラリ
96 とリンクしてください。 @ref m17nIntro を参照。 */
98 /***en @section extralib External libraries and data
100 The m17n library utilizes these external libraries. They are not
101 mandatory but several functions of the m17n library depend on them.
104 <li> m17n-db -- http://www.m17n.org/m17n-lib/download/m17n-db-1.2.0.tar.gz
106 Used by @ref m17nShell and @ref m17nGUI.
108 <li> libxml2 -- http://xmlsoft.org/
110 Used by the functions mtext_serialize () and mtext_deserialize ().
111 Those functions return NULL when libxml2 is not available,
113 <li> fribidi -- http://fribidi.sourceforge.net/
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
119 <li> freetype -- http://www.freetype.org/
121 Used for handling local fonts.
123 <li> fontconfig -- http://nexp.cs.pdx.edu/fontconfig/
125 Used for handling local fonts supported by the freetype library.
127 <li> fontconfig -- http://freedesktop.org/Software/fontconfig
129 Used for finding local fonts in combination with Xft.
131 <li> xft -- http://freedesktop.org/Software/Xft
133 Used for drawing text with local fonts by X Render Extension of X
134 server in combination with fontconfig.
138 Used for rendering text with local fonts on bitmap/pixmap.
140 <li> libotf -- http://www.m17n.org/libotf/
142 Used for handling OpenTypee fonts in combination with freetype
145 <li> anthy -- http://anthy.sourceforge.jp/
147 Used for the Japanese input method ja-anthy.mim.
149 <li> wordcut -- http://thaiwordseg.sourceforge.net/
151 Used for finding Thai word boundary in the example program
157 /***ja @section extralib 外部ライブラリ/データ
159 m17n ライブラリは以下の外部ライブラリを利用しています。必須ではありま
160 せんが、m17n ライブラリの幾つかの関数はこれらに依存しています。
163 <li> m17n-db -- http://www.m17n.org/m17n-lib/download/m17n-db-1.2.0.tar.gz
165 @ref m17nShell と @ref m17nGUI が使います。
167 <li> libxml2 -- http://xmlsoft.org/
169 関数 mtext_serialize () と mtext_deserialize () が使います。
170 libxml2 が利用できない時には、これらの関数は NULL を返します。
173 <li> fribidi -- http://fribidi.sourceforge.net/
175 BIDI 処理に使います。利用できない時は、m17n ライブラリの表示エン
176 ジンは Arabic やHebrew などのスクリプトを正しく処理できません。
178 <li> freetype -- http://www.freetype.org/
182 <li> fontconfig -- http://nexp.cs.pdx.edu/fontconfig/
184 Xft と共に、ローカルフォントの検索に使います。
186 <li> xft -- http://freedesktop.org/Software/Xft
188 fontconfig と共に X サーバの XRender 拡張を利用してテキストをロー
192 テキストをローカルフォントで bitmap/pixmap 上に表示するのに使いま
195 <li> libotf -- http://www.m17n.org/libotf/
197 freetype と共に OpenType フォントの処理に使います。
199 <li> anthy -- http://anthy.sourceforge.jp/
201 日本語入力メソッド ja-anthy.mim が使います。
203 <li> wordcut -- http://thaiwordseg.sourceforge.net/
205 プログラム例 example/linebreak.c 中でタイ語の語の境界を見つけるた
211 /***en @section contact Contact us:
213 Global IT Security Group\n
214 National Information Technology Research Institute\n
215 Institute of Advanced Industrial Science and Technology
217 Web: http://www.m17n.org/m17n-lib/
219 Bug report: m17n-lib-bug@m17n.org
221 Mailing lists: http://www.m17n.org/m17n-lib/mailinglist.html
224 /***ja @section contact 連絡先:
230 Web: http://www.m17n.org/m17n-lib/
232 バグレポート: m17n-lib-bug@m17n.org
234 メイリングリスト: http://www.m17n.org/m17n-lib-ja/mailinglist.htm
237 /***en @section ack Acknowledgements */
238 /***ja @section ack 謝辞 */
244 <li> Dimitri van Heesch <dimitri@stack.nl>
246 Author of Doxygen <http://www.stack.nl/~dimitri/doxygen/>. Without
247 this tool, it would have been impossible to create this documentation.
249 <li> Information-technology Promotion Agency (IPA), Japan
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.
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>
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".