*** empty log message ***
[m17n/m17n-docs.git] / mainpage.txt
1 /***en @mainpage The M17N Library Documentation */      -*- coding: euc-jp; -*-
2 /***ja @mainpage M17N ¥é¥¤¥Ö¥é¥ê */
3
4 /***en @section what What is the m17n library? */
5 /***ja @section what M17N ¥é¥¤¥Ö¥é¥ê¤È¤Ï? */
6
7 /***
8 The @e m17n @e library is a multilingual text processing library for
9 the C language.
10
11 <ul>
12
13 <li> It is a free and open source software.
14
15 <li> It is for any GNU/Linux and Unix applications/libraries.
16
17 <li> It realizes multilingualization of many aspects of
18 applications/libraries.
19
20 </ul> 
21
22 The word "m17n" is an abbreviation of "multilingualization".
23
24 The m17n library provides following facilities to handle
25 multilingual text.
26
27 <ul>
28
29 <li> @e M-text: A data structure for a multilingual text.  It is
30 basically a string but with attributes called text property, and
31 is designed to substitute for the C string.  It is the most important
32 object of the m17n library.
33
34 <li> Functions for creating and processing M-texts.
35
36 <li> Functions for converting M-texts from/to strings encoded in
37 various existing formats.
38
39 <li> A huge character space, which contains all the Unicode
40 characters and more non-Unicode characters.
41
42 <li> @e Chartable: A data structure that contains per-character
43 information efficiently.
44
45 <li> Functions for inputting and displaying M-text on a window
46 system.
47
48 </ul>
49 */
50 /***en @section usage How to use it? */
51 /***ja @section usage ÍøÍÑË¡ */
52 /***
53 Just include <m17n.h> in your program, and link it with the m17n
54 library by -lm17n.  See @ref m17nIntro @latexonly
55 (P.\pageref{group__m17nIntro}) @endlatexonly for the detail.  */
56
57 /***en @section contact Contact us: */
58 /***ja @section contact Ï¢ÍíÀè */
59 /***
60 Global IT Security Group\n
61 National Information Technology Research Institute\n
62 Institute of Advanced Industrial Science and Technology
63
64 Web: http://www.m17n.org/m17n-lib/
65
66 Bug report: m17n-lib-bug@m17n.org
67
68 Mailing list (English): m17n-lib@m17n.org
69
70 Mailing list (Japanese): m17n-lib-ja@m17n.org
71 */
72
73 /***en @section ack Acknowledgements */
74 /***ja @section ack ¼Õ¼­ */
75 /***
76 Special thanks to:
77
78 <ul>
79
80 <li> Dimitri van Heesch <dimitri@stack.nl>
81
82 Author of Doxygen (<http://www.stack.nl/~dimitri/doxygen/>).  Without
83 this tool, it would have been impossible to create this document.
84
85 </ul>
86 */
87