[m17n/m17n-docs.git] / mainpage.txt

/* -*- coding: euc-jp; -*- */
/***en @mainpage The m17n Library Documentation */
/***ja @mainpage m17n ¥é¥¤¥Ö¥é¥ê */

/***en @section what What is the m17n library? 

The @e m17n @e library is a multilingual text processing library for
the C language.

<ul>

<li> It is a free and open source software.

<li> It is for any GNU/Linux and Unix applications/libraries.

<li> It realizes multilingualization of many aspects of
applications/libraries.

</ul> 

The word "m17n" is an abbreviation of "multilingualization".

The m17n library provides following facilities to handle
multilingual text.

<ul>

<li> @e M-text: A data structure for a multilingual text.  It is
basically a string but with attributes called text property, and
is designed to substitute for the C string.  It is the most important
object of the m17n library.

<li> Functions for creating and processing M-texts.

<li> Functions for converting M-texts from/to strings encoded in
various existing formats.

<li> A huge character space, which contains all the Unicode
characters and more non-Unicode characters.

<li> @e Chartable: A data structure that contains per-character
information efficiently.

<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.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.  */

/***ja @section usage ÍøÍÑÊýË¡ 

<m17n.h> ¤ò¥×¥í¥°¥é¥à¤Ë include ¤·¡¢-lm17n ¤Ç m17n ¥é¥¤¥Ö¥é¥ê¤È¥ê¥ó¥¯
¤·¤Æ¤¯¤À¤µ¤¤¡£ @ref m17nIntro ¤ò»²¾È¡£@latexonly
(P.\pageref{group__m17nIntro}) @endlatexonly  */

/***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.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 avairable,

<li> fribidi -- http://fribidi.sourceforge.net/

     Used for BIDI processing.  If it is not avairable, the rendering
     engine of the m17n library can't handle such scritp as Arabic and
     Hebrew correctly.

<li> freetype -- http://www.freetype.org/

     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> libotf  -- http://www.m17n.org/libotf/

     Used for handling OpenTypee fonts in combination with freetype
     and Xft.

<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.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/

     Freetype ¥é¥¤¥Ö¥é¥ê¤Ç¥µ¥Ý¡¼¥È¤µ¤ì¤Æ¤¤¤ë¥í¡¼¥«¥ë¥Õ¥©¥ó¥È¤Î½èÍý¤Ë»È
     ¤¤¤Þ¤¹¡£

<li> fontconfig -- http://freedesktop.org/Software/fontconfig

     Xft ¤È¶¦¤Ë¡¢¥í¡¼¥«¥ë¥Õ¥©¥ó¥È¤Î¸¡º÷¤Ë»È¤¤¤Þ¤¹¡£

<li> xft -- http://freedesktop.org/Software/Xft

     fontconfig ¤È¶¦¤Ë X ¥µ¡¼¥Ð¤Î XRender ³ÈÄ¥¤òÍøÍѤ·¤Æ¥Æ¥­¥¹¥È¤ò¥í¡¼
     ¥«¥ë¥Õ¥©¥ó¥È¤Çɽ¼¨¤¹¤ë¤¿¤á¤Ë»È¤¤¤Þ¤¹¡£

<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
Institute of Advanced Industrial Science and Technology

Web: http://www.m17n.org/m17n-lib/

Bug report: m17n-lib-bug@m17n.org

Subscribe the mailing list 
@li (English): http://www.m17n.org/m17n-lib/m17n-lib-archive/index.html
@li (Japanese): http://www.m17n.org/m17n-lib/m17n-lib-ja-archive/index.html
*/
/***ja @section contact Ï¢ÍíÀè:

ÆÈΩ¹ÔÀ¯Ë¡¿Í »º¶Èµ»½ÑÁí¹ç¸¦µæ½ê\n
¾ðÊó½èÍý¸¦µæÉôÌç\n
¥°¥í¡¼¥Ð¥ë IT ¥»¥­¥å¥ê¥Æ¥£¥°¥ë¡¼¥×

Web: http://www.m17n.org/m17n-lib/

¥Ð¥°¥ì¥Ý¡¼¥È: m17n-lib-bug@m17n.org

¥á¥¤¥ê¥ó¥°¥ê¥¹¥È¹ØÆÉ (±Ñ¸ì): http://www.m17n.org/m17n-lib/m17n-lib-archive/index.html

¥á¥¤¥ê¥ó¥°¥ê¥¹¥È¹ØÆÉ (ÆüËܸì): http://www.m17n.org/m17n-lib/m17n-lib-ja-archive/index.html
*/
/***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 documentation.

<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-2004
  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
*/