-/***en
-@mainpage The M17N Library Documentation
+/* -*- coding: utf-8; -*- */
+/***en @mainpage The m17n Library Documentation */
+/***ja @mainpage m17n ライブラリ */
-@section what What is the m17n library?
+/***en @section what What is the m17n library?
The @e m17n @e library is a multilingual text processing library for
the C language.
<li> @e Chartable: A data structure that contains per-character
information efficiently.
-<li> Functions for inputting and displaying M-text on a window
+<li> Functions for inputting and displaying M-texts on a window
system.
</ul>
+*/
+/***ja @section what m17n ライブラリとは?
+
+@e m17nライブラリ は C 言語用の多言語文書処理ライブラリです。
+
+<ul>
+
+<li> 自由公開ソフトウェアです。
+
+<li> GNU/Linux と Unix のアプリケーションやライブラリから利用できます。
+
+<li> アプリケーションやライブラリのさまざまな側面で、多言語化を実現し
+ます。
+
+</ul>
+
+"m17n" とは "multilingualization" の省略形です。
+
+m17n ライブラリは多言語を扱うため、以下の機能を提供します。
+
+<ul>
+
+<li> @e M-text: 多言語テキスト用のデータ構造。基本的には文字列であるが、
+テキストプロパティと呼ばれる属性が付いており、C の文字列の代わりになる
+よう設計されている。m17n ライブラリで最も重要なオブジェクト。
+
+<li> M-text を作ったり取り扱ったりするための関数。
+
+<li> M-text と既存のフォーマットでコード化された文字列との間の変換を行
+う関数。
+
+<li> 巨大な文字空間。 Unicode 文字すべてとそれ以上の数の非 Unicode 文
+字を含むことができる。
+
+<li> @e 文字テーブル: 文字毎の情報を効率的に保持するデータ構造。
+
+<li> M-text をウィンドウシステム上で入力/表示する関数。
+
+</ul>
+*/
+/***en @section usage How to use it?
+
+Simply include <m17n<EM></EM>.h> in your program, and link it with the m17n
+library by -lm17n. See @ref m17nIntro for the detail. */
+
+/***ja @section usage 利用方法
+
+<m17n<EM></EM>.h> をプログラムに include し、-lm17n で m17n ライブラリ
+とリンクしてください。 @ref m17nIntro を参照。 */
+
+/***en @section extralib External libraries and data
+
+The m17n library utilizes these external libraries. They are not
+mandatory but several functions of the m17n library depend on them.
+
+<ul>
+<li> m17n-db -- http://www.m17n.org/m17n-lib/download/m17n-db-1.2.0.tar.gz
+
+ Used by @ref m17nShell and @ref m17nGUI.
+
+<li> libxml2 -- http://xmlsoft.org/
+
+ Used by the functions mtext_serialize () and mtext_deserialize ().
+ Those functions return NULL when libxml2 is not available,
+
+<li> fribidi -- http://fribidi.sourceforge.net/
+
+ Used for BIDI processing. If it is not available, the rendering
+ engine of the m17n library can't handle such script as Arabic and
+ Hebrew correctly.
+
+<li> freetype -- http://www.freetype.org/
+
+ Used for handling local fonts.
+
+<li> fontconfig -- http://nexp.cs.pdx.edu/fontconfig/
+
+ Used for handling local fonts supported by the freetype library.
+
+<li> fontconfig -- http://freedesktop.org/Software/fontconfig
+
+ Used for finding local fonts in combination with Xft.
+
+<li> xft -- http://freedesktop.org/Software/Xft
+
+ Used for drawing text with local fonts by X Render Extension of X
+ server in combination with fontconfig.
+
+<li> GD
+
+ Used for rendering text with local fonts on bitmap/pixmap.
-@section usage How to use it?
+<li> libotf -- http://www.m17n.org/libotf/
-Just include <m17n.h> in your program, and link it with the m17n
-library by -lm17n. See @ref m17nIntro @latexonly
-(P.\pageref{group__m17nIntro}) @endlatexonly for the detail.
+ Used for handling OpenTypee fonts in combination with freetype
+ and Xft.
-@section contact Contact us:
+<li> anthy -- http://anthy.sourceforge.jp/
+
+ Used for the Japanese input method ja-anthy.mim.
+
+<li> wordcut -- http://thaiwordseg.sourceforge.net/
+
+ Used for finding Thai word boundary in the example program
+ example/linebreak.c.
+
+</ul>
+
+*/
+/***ja @section extralib 外部ライブラリ/データ
+
+m17n ライブラリは以下の外部ライブラリを利用しています。必須ではありま
+せんが、m17n ライブラリの幾つかの関数はこれらに依存しています。
+
+<ul>
+<li> m17n-db -- http://www.m17n.org/m17n-lib/download/m17n-db-1.2.0.tar.gz
+
+ @ref m17nShell と @ref m17nGUI が使います。
+
+<li> libxml2 -- http://xmlsoft.org/
+
+ 関数 mtext_serialize () と mtext_deserialize () が使います。
+ libxml2 が利用できない時には、これらの関数は NULL を返します。
+
+
+<li> fribidi -- http://fribidi.sourceforge.net/
+
+ BIDI 処理に使います。利用できない時は、m17n ライブラリの表示エン
+ ジンは Arabic やHebrew などのスクリプトを正しく処理できません。
+
+<li> freetype -- http://www.freetype.org/
+
+ ローカルフォントの処理に使います。
+
+<li> fontconfig -- http://nexp.cs.pdx.edu/fontconfig/
+
+ Xft と共に、ローカルフォントの検索に使います。
+
+<li> xft -- http://freedesktop.org/Software/Xft
+
+ fontconfig と共に X サーバの XRender 拡張を利用してテキストをロー
+ カルフォントで表示するために使います。
+
+<li> GD
+ テキストをローカルフォントで bitmap/pixmap 上に表示するのに使いま
+ す。
+
+<li> libotf -- http://www.m17n.org/libotf/
+
+ freetype と共に OpenType フォントの処理に使います。
+
+<li> anthy -- http://anthy.sourceforge.jp/
+
+ 日本語入力メソッド ja-anthy.mim が使います。
+
+<li> wordcut -- http://thaiwordseg.sourceforge.net/
+
+ プログラム例 example/linebreak.c 中でタイ語の語の境界を見つけるた
+ めに使っています。
+
+</ul>
+*/
+
+/***en @section contact Contact us:
Global IT Security Group\n
National Information Technology Research Institute\n
Bug report: m17n-lib-bug@m17n.org
-Mailing list (English): m17n-lib@m17n.org
+Mailing lists: http://www.m17n.org/m17n-lib/mailinglist.html
-Mailing list (Japanese): m17n-lib-ja@m17n.org
+*/
+/***ja @section contact 連絡先:
+
+独立行政法人 産業技術総合研究所\n
+情報技術研究部門\n
+グローバル IT セキュリティグループ
+
+Web: http://www.m17n.org/m17n-lib/
+
+バグレポート: m17n-lib-bug@m17n.org
-@section Acknowledgements
+メイリングリスト: http://www.m17n.org/m17n-lib-ja/mailinglist.htm
+*/
+/***en @section ack Acknowledgements */
+/***ja @section ack 謝辞 */
+/***
Special thanks to:
<ul>
<li> Dimitri van Heesch <dimitri@stack.nl>
-Author of Doxygen (<http://www.stack.nl/~dimitri/doxygen/>). Without
-this tool, it would have been impossible to create this document.
+Author of Doxygen <http://www.stack.nl/~dimitri/doxygen/>. Without
+this tool, it would have been impossible to create this documentation.
-</ul>
+<li> Information-technology Promotion Agency (IPA), Japan
+
+Writing this documentation was partially funded by
+Information-technology Promotion Agency (IPA)
+<http://www.ipa.go.jp/about/english/index.html> in fiscal year 2001.
+</ul>
*/
+/***
+@htmlonly
+<hr>
+Copyright (C) 2001 Information-technology Promotion Agency (IPA)<p>
+Copyright (C) 2001-2006
+ National Institute of Advanced Industrial Science and Technology (AIST)<p>
+
+Permission is granted to copy, distribute and/or modify this document
+under the terms of the GNU Free Documentation License, Version 1.2 or
+any later version published by the Free Software Foundation; with no
+Invariant Section, Front-Cover Texts "The m17n library documentation",
+and no Back-Cover Texts. A copy of the license is included in the
+appendix entitled "GNU Free Documentation License".
+@endhtmlonly
+*/