1 /* -*- coding: euc-jp; -*- */
2 /***en @mainpage The M17N Library Documentation */
3 /***ja @mainpage M17N ¥é¥¤¥Ö¥é¥ê */
5 /***en @section what What is the m17n library? */
6 /***ja @section what M17N ¥é¥¤¥Ö¥é¥ê¤È¤Ï? */
9 The @e m17n @e library is a multilingual text processing library for
14 <li> It is a free and open source software.
16 <li> It is for any GNU/Linux and Unix applications/libraries.
18 <li> It realizes multilingualization of many aspects of
19 applications/libraries.
23 The word "m17n" is an abbreviation of "multilingualization".
25 The m17n library provides following facilities to handle
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.
35 <li> Functions for creating and processing M-texts.
37 <li> Functions for converting M-texts from/to strings encoded in
38 various existing formats.
40 <li> A huge character space, which contains all the Unicode
41 characters and more non-Unicode characters.
43 <li> @e Chartable: A data structure that contains per-character
44 information efficiently.
46 <li> Functions for inputting and displaying M-text on a window
51 /***en @section usage How to use it? */
52 /***ja @section usage ÍøÍÑË¡ */
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. */
58 /***en @section extralib External libraries and data */
59 /***ja @section extralib ³°Éô¥é¥¤¥Ö¥é¥ê¡¿¥Ç¡¼¥¿ */
62 The m17n library utilizes these external libraries. They are not
63 mandatory but several functions of the m17n library depend on them.
66 <li> m17n-db -- http://www.m17n.org/m17n-db/
68 Used by @ref m17nShell and @ref m17nGUI.
70 <li> libxml2 -- http://xmlsoft.org/
72 Used by the functions mtext_serialize () and mtext_deserialize ().
73 Those functions return NULL libxml2 is not avairable,
75 <li> fribidi -- http://fribidi.sourceforge.net/
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
81 <li> freetype -- http://www.freetype.org/
83 Used for handling TrueType and Type1 fonts.
85 <li> libotf -- http://www.m17n.org/libotf/
87 Used for handling OpenTypee fonts.
89 <li> anthy -- http://anthy.sourceforge.jp/
91 Used for the Japanese input method ja-anthy.mim.
93 <li> wordcut -- http://thaiwordseg.sourceforge.net/
95 Used for finding Thai word boundary in the example program
102 /***en @section contact Contact us: */
103 /***ja @section contact Ï¢ÍíÀè */
105 Global IT Security Group\n
106 National Information Technology Research Institute\n
107 Institute of Advanced Industrial Science and Technology
109 Web: http://www.m17n.org/m17n-lib/
111 Bug report: m17n-lib-bug@m17n.org
113 Mailing list (English): m17n-lib@m17n.org
115 Mailing list (Japanese): m17n-lib-ja@m17n.org
118 /***en @section ack Acknowledgements */
119 /***ja @section ack ¼Õ¼ */
125 <li> Dimitri van Heesch <dimitri@stack.nl>
127 Author of Doxygen <http://www.stack.nl/~dimitri/doxygen/>. Without
128 this tool, it would have been impossible to create this documentation.
130 <li> Information-technology Promotion Agency (IPA), Japan
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.
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>
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".