(example): Encoded in utf-8.
[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
7 The @e m17n @e library is a multilingual text processing library for
8 the C language.
9
10 <ul>
11
12 <li> It is a free and open source software.
13
14 <li> It is for any GNU/Linux and Unix applications/libraries.
15
16 <li> It realizes multilingualization of many aspects of
17 applications/libraries.
18
19 </ul> 
20
21 The word "m17n" is an abbreviation of "multilingualization".
22
23 The m17n library provides following facilities to handle
24 multilingual text.
25
26 <ul>
27
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.
32
33 <li> Functions for creating and processing M-texts.
34
35 <li> Functions for converting M-texts from/to strings encoded in
36 various existing formats.
37
38 <li> A huge character space, which contains all the Unicode
39 characters and more non-Unicode characters.
40
41 <li> @e Chartable: A data structure that contains per-character
42 information efficiently.
43
44 <li> Functions for inputting and displaying M-texts on a window
45 system.
46
47 </ul>
48 */
49 /***ja @section what m17n ¥é¥¤¥Ö¥é¥ê¤È¤Ï? 
50
51 @e m17n¥é¥¤¥Ö¥é¥ê ¤Ï C ¸À¸ìÍѤο¸À¸ìʸ½ñ½èÍý¥é¥¤¥Ö¥é¥ê¤Ç¤¹¡£
52
53 <ul>
54
55 <li> ¼«Í³¸ø³«¥½¥Õ¥È¥¦¥§¥¢¤Ç¤¹¡£
56
57 <li> GNU/Linux ¤È Unix ¤Î¥¢¥×¥ê¥±¡¼¥·¥ç¥ó¤ä¥é¥¤¥Ö¥é¥ê¤«¤éÍøÍѤǤ­¤Þ¤¹¡£
58
59 <li> ¥¢¥×¥ê¥±¡¼¥·¥ç¥ó¤ä¥é¥¤¥Ö¥é¥ê¤Î¤µ¤Þ¤¶¤Þ¤Ê¦Ì̤ǡ¢Â¿¸À¸ì²½¤ò¼Â¸½¤·
60 ¤Þ¤¹¡£
61
62 </ul> 
63
64 "m17n" ¤È¤Ï "multilingualization" ¤Î¾Êά·Á¤Ç¤¹¡£
65
66 m17n ¥é¥¤¥Ö¥é¥ê¤Ï¿¸À¸ì¤ò°·¤¦¤¿¤á¡¢°Ê²¼¤Îµ¡Ç½¤òÄ󶡤·¤Þ¤¹¡£
67
68 <ul>
69
70 <li> @e M-text: Â¿¸À¸ì¥Æ¥­¥¹¥ÈÍѤΥǡ¼¥¿¹½Â¤¡£´ðËÜŪ¤Ë¤Ïʸ»úÎó¤Ç¤¢¤ë¤¬¡¢
71 ¥Æ¥­¥¹¥È¥×¥í¥Ñ¥Æ¥£¤È¸Æ¤Ð¤ì¤ë°À­¤¬ÉÕ¤¤¤Æ¤ª¤ê¡¢C ¤Îʸ»úÎó¤ÎÂå¤ï¤ê¤Ë¤Ê¤ë
72 ¤è¤¦À߷פµ¤ì¤Æ¤¤¤ë¡£m17n ¥é¥¤¥Ö¥é¥ê¤ÇºÇ¤â½ÅÍפʥª¥Ö¥¸¥§¥¯¥È¡£
73
74 <li> M-text ¤òºî¤Ã¤¿¤ê¼è¤ê°·¤Ã¤¿¤ê¤¹¤ë¤¿¤á¤Î´Ø¿ô¡£
75
76 <li> M-text ¤È´û¸¤Î¥Õ¥©¡¼¥Þ¥Ã¥È¤Ç¥³¡¼¥É²½¤µ¤ì¤¿Ê¸»úÎó¤È¤Î´Ö¤ÎÊÑ´¹¤ò¹Ô
77 ¤¦´Ø¿ô¡£
78
79 <li> µðÂç¤Êʸ»ú¶õ´Ö¡£ Unicode Ê¸»ú¤¹¤Ù¤Æ¤È¤½¤ì°Ê¾å¤Î¿ô¤ÎÈó Unicode Ê¸
80 »ú¤ò´Þ¤à¤³¤È¤¬¤Ç¤­¤ë¡£
81
82 <li> @e Ê¸»ú¥Æ¡¼¥Ö¥ë: Ê¸»úËè¤Î¾ðÊó¤ò¸úΨŪ¤ËÊÝ»ý¤¹¤ë¥Ç¡¼¥¿¹½Â¤¡£
83
84 <li>  M-text ¤ò¥¦¥£¥ó¥É¥¦¥·¥¹¥Æ¥à¾å¤ÇÆþÎÏ¡¿É½¼¨¤¹¤ë´Ø¿ô¡£
85
86 </ul>
87 */
88 /***en @section usage How to use it? 
89
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.  */
92
93 /***ja @section usage ÍøÍÑÊýË¡ 
94
95 <m17n<EM></EM>.h> ¤ò¥×¥í¥°¥é¥à¤Ë include ¤·¡¢-lm17n ¤Ç m17n ¥é¥¤¥Ö¥é¥ê
96 ¤È¥ê¥ó¥¯¤·¤Æ¤¯¤À¤µ¤¤¡£ @ref m17nIntro ¤ò»²¾È¡£  */
97
98 /***en @section extralib External libraries and data 
99
100 The m17n library utilizes these external libraries.  They are not
101 mandatory but several functions of the m17n library depend on them.
102
103 <ul>
104 <li> m17n-db -- http://www.m17n.org/m17n-lib/download/m17n-db-1.2.0.tar.gz
105
106      Used by @ref m17nShell and @ref m17nGUI.
107
108 <li> libxml2 -- http://xmlsoft.org/
109
110      Used by the functions mtext_serialize () and mtext_deserialize ().
111      Those functions return NULL when libxml2 is not available,
112
113 <li> fribidi -- http://fribidi.sourceforge.net/
114
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
117      Hebrew correctly.
118
119 <li> freetype -- http://www.freetype.org/
120
121      Used for handling local fonts.
122
123 <li> fontconfig -- http://nexp.cs.pdx.edu/fontconfig/
124
125      Used for handling local fonts supported by the freetype library.
126
127 <li> fontconfig -- http://freedesktop.org/Software/fontconfig
128
129      Used for finding local fonts in combination with Xft.
130
131 <li> xft -- http://freedesktop.org/Software/Xft
132
133      Used for drawing text with local fonts by X Render Extension of X
134      server in combination with fontconfig.
135
136 <li> GD
137
138      Used for rendering text with local fonts on bitmap/pixmap.
139
140 <li> libotf  -- http://www.m17n.org/libotf/
141
142      Used for handling OpenTypee fonts in combination with freetype
143      and Xft.
144
145 <li> anthy -- http://anthy.sourceforge.jp/
146
147      Used for the Japanese input method ja-anthy.mim.
148
149 <li> wordcut -- http://thaiwordseg.sourceforge.net/
150
151      Used for finding Thai word boundary in the example program
152      example/linebreak.c.
153
154 </ul>
155
156 */
157 /***ja @section extralib ³°Éô¥é¥¤¥Ö¥é¥ê¡¿¥Ç¡¼¥¿ 
158
159 m17n ¥é¥¤¥Ö¥é¥ê¤Ï°Ê²¼¤Î³°Éô¥é¥¤¥Ö¥é¥ê¤òÍøÍѤ·¤Æ¤¤¤Þ¤¹¡£É¬¿Ü¤Ç¤Ï¤¢¤ê¤Þ
160 ¤»¤ó¤¬¡¢m17n ¥é¥¤¥Ö¥é¥ê¤Î´ö¤Ä¤«¤Î´Ø¿ô¤Ï¤³¤ì¤é¤Ë°Í¸¤·¤Æ¤¤¤Þ¤¹¡£
161
162 <ul>
163 <li> m17n-db -- http://www.m17n.org/m17n-lib/download/m17n-db-1.2.0.tar.gz
164
165      @ref m17nShell ¤È @ref m17nGUI ¤¬»È¤¤¤Þ¤¹¡£
166
167 <li> libxml2 -- http://xmlsoft.org/
168
169      ´Ø¿ô mtext_serialize () ¤È mtext_deserialize () ¤¬»È¤¤¤Þ¤¹¡£
170      libxml2 ¤¬ÍøÍѤǤ­¤Ê¤¤»þ¤Ë¤Ï¡¢¤³¤ì¤é¤Î´Ø¿ô¤Ï NULL ¤òÊÖ¤·¤Þ¤¹¡£
171
172
173 <li> fribidi -- http://fribidi.sourceforge.net/
174
175      BIDI ½èÍý¤Ë»È¤¤¤Þ¤¹¡£ÍøÍѤǤ­¤Ê¤¤»þ¤Ï¡¢m17n ¥é¥¤¥Ö¥é¥ê¤Îɽ¼¨¥¨¥ó
176      ¥¸¥ó¤Ï Arabic ¤äHebrew ¤Ê¤É¤Î¥¹¥¯¥ê¥×¥È¤òÀµ¤·¤¯½èÍý¤Ç¤­¤Þ¤»¤ó¡£
177
178 <li> freetype -- http://www.freetype.org/
179
180      ¥í¡¼¥«¥ë¥Õ¥©¥ó¥È¤Î½èÍý¤Ë»È¤¤¤Þ¤¹¡£
181
182 <li> fontconfig -- http://nexp.cs.pdx.edu/fontconfig/
183
184      Xft ¤È¶¦¤Ë¡¢¥í¡¼¥«¥ë¥Õ¥©¥ó¥È¤Î¸¡º÷¤Ë»È¤¤¤Þ¤¹¡£
185
186 <li> xft -- http://freedesktop.org/Software/Xft
187
188      fontconfig ¤È¶¦¤Ë X ¥µ¡¼¥Ð¤Î XRender ³ÈÄ¥¤òÍøÍѤ·¤Æ¥Æ¥­¥¹¥È¤ò¥í¡¼
189      ¥«¥ë¥Õ¥©¥ó¥È¤Çɽ¼¨¤¹¤ë¤¿¤á¤Ë»È¤¤¤Þ¤¹¡£
190
191 <li> GD
192      ¥Æ¥­¥¹¥È¤ò¥í¡¼¥«¥ë¥Õ¥©¥ó¥È¤Ç bitmap/pixmap ¾å¤Ëɽ¼¨¤¹¤ë¤Î¤Ë»È¤¤¤Þ
193      ¤¹¡£
194
195 <li> libotf  -- http://www.m17n.org/libotf/
196
197      freetype ¤È¶¦¤Ë OpenType ¥Õ¥©¥ó¥È¤Î½èÍý¤Ë»È¤¤¤Þ¤¹¡£
198
199 <li> anthy -- http://anthy.sourceforge.jp/
200
201      ÆüËܸìÆþÎϥ᥽¥Ã¥É ja-anthy.mim ¤¬»È¤¤¤Þ¤¹¡£
202
203 <li> wordcut -- http://thaiwordseg.sourceforge.net/
204
205      ¥×¥í¥°¥é¥àÎã example/linebreak.c Ãæ¤Ç¥¿¥¤¸ì¤Î¸ì¤Î¶­³¦¤ò¸«¤Ä¤±¤ë¤¿
206      ¤á¤Ë»È¤Ã¤Æ¤¤¤Þ¤¹¡£
207
208 </ul>
209 */
210
211 /***en @section contact Contact us: 
212
213 Global IT Security Group\n
214 National Information Technology Research Institute\n
215 Institute of Advanced Industrial Science and Technology
216
217 Web: http://www.m17n.org/m17n-lib/
218
219 Bug report: m17n-lib-bug@m17n.org
220
221 Mailing lists: http://www.m17n.org/m17n-lib/mailinglist.html
222
223 */
224 /***ja @section contact Ï¢ÍíÀè:
225
226 ÆÈΩ¹ÔÀ¯Ë¡¿Í »º¶Èµ»½ÑÁí¹ç¸¦µæ½ê\n
227 ¾ðÊ󵻽Ѹ¦µæÉôÌç\n
228 ¥°¥í¡¼¥Ð¥ë IT ¥»¥­¥å¥ê¥Æ¥£¥°¥ë¡¼¥×
229
230 Web: http://www.m17n.org/m17n-lib/
231
232 ¥Ð¥°¥ì¥Ý¡¼¥È: m17n-lib-bug@m17n.org
233
234 ¥á¥¤¥ê¥ó¥°¥ê¥¹¥È: http://www.m17n.org/m17n-lib-ja/mailinglist.htm
235
236 */
237 /***en @section ack Acknowledgements */
238 /***ja @section ack ¼Õ¼­ */
239 /***
240 Special thanks to:
241
242 <ul>
243
244 <li> Dimitri van Heesch <dimitri@stack.nl>
245
246 Author of Doxygen <http://www.stack.nl/~dimitri/doxygen/>.  Without
247 this tool, it would have been impossible to create this documentation.
248
249 <li> Information-technology Promotion Agency (IPA), Japan
250
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.
254
255 </ul>
256 */
257
258 /*** 
259 @htmlonly
260 <hr>
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>
264
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".
271 @endhtmlonly
272 */