*** empty log message ***

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

diff --git a/mainpage.txt b/mainpage.txt
index 34365c4..1b258c5 100644 (file)
--- a/mainpage.txt
+++ b/mainpage.txt
@@ -1,8 +1,11 @@
-/***en
-@mainpage The M17N Library Documentation
+/* -*- coding: euc-jp; -*- */
+/***en @mainpage The m17n Library Documentation */
+/***ja @mainpage m17n ¥é¥¤¥Ö¥é¥ê */
 
-@section what What is the m17n library?
+/***en @section what What is the m17n library? */
+/***ja @section what m17n ¥é¥¤¥Ö¥é¥ê¤È¤Ï? */
 
+/***
 The @e m17n @e library is a multilingual text processing library for
 the C language.
 
@@ -44,15 +47,61 @@ information efficiently.
 system.
 
 </ul>
+*/
+/***en @section usage How to use it? */
+/***ja @section usage ÍøÍÑË¡ */
+/***
+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.  */
 
-@section usage How to use it?
+/***en @section extralib External libraries and data */
+/***ja @section extralib ³°Éô¥é¥¤¥Ö¥é¥ê¡¿¥Ç¡¼¥¿ */
+/***
 
-Just 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.
+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 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 TrueType and Type1 fonts.
+
+<li> libotf  -- http://www.m17n.org/libotf/
+
+     Used for handling OpenTypee fonts.
 
-@section contact Contact us:
+<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>
+
+*/
+
+/***en @section contact Contact us: */
+/***ja @section contact Ï¢ÍíÀè */
+/***
 Global IT Security Group\n
 National Information Technology Research Institute\n
 Institute of Advanced Industrial Science and Technology
@@ -64,19 +113,41 @@ Bug report: m17n-lib-bug@m17n.org
 Mailing list (English): m17n-lib@m17n.org
 
 Mailing list (Japanese): m17n-lib-ja@m17n.org
+*/
 
-@section Acknowledgements
-
+/***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 document.
+Author of Doxygen <http://www.stack.nl/~dimitri/doxygen/>.  Without
+this tool, it would have been impossible to create this documentation.
 
-</ul>
+<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
+*/