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