1. What's this?
===============

This extension for OpenOffice.org provides some Calc functions to manipulate
Japanese text. 

 1.1 FURIGANA()
    This function translates Japanese Kana-Kanji mixed text into Katakana.

 1.2 ASC()
    This function converts full-width characters into half ones.

 1.3 JIS()
    This function converts half-width characters into full ones.

 1.4 KATAKANA()
    This function converts Hiragana characters into full-width Katakana.

 1.5 HIRAGANA()
    This function converts Katakana characters into full-width Hiragana.

 1.6 HEPBURN()
    This function converts full-width Katakana characters into alphabetic
    characters by Hepburn rule.

2. Requirements
===============

2.1 Environment

 * GNU/Linux or Windows

2.2 For installation

 * OpenOffice.org 2.0 or higher
  - Download it from http://download.openoffice.org/index.html
  - OpenOffice.org is a multiplatform and multilingual office suite.
  - A free software distributed under the LGPL license.

 * mecab 0.91 (for GNU/Linux only)
  - Download it from http://mecab.sourceforge.jp/
  - A Japanese morphological analyzer.
  - A free software distributed under the LGPL license.
  - Other versions have not been supported yet.

 * anthy 7500b (for GNU/Linux only)
  - Download it from http://anthy.sourceforge.jp/
  - Anthy is a system for Japanese input method. It converts Hiragana text to Kana Kanji mixed text.
  - A free software distributed under the LGPL license.
  - Other versions have not been supported yet.

2.3 For compilation

 * OpenOffice.org SDK 2.0 or higher
  - Download it from http://download.openoffice.org/index.html
  - An add-on for the OpenOffice.org office suite.

 * GNU Make (for GNU/Linux)
   - Download it from http://www.gnu.org/software/make/make.html
   - Generates executables and other non-source programs

 * g++ (for GNU/Linux)
   - Download it from http://gcc.gnu.org/
   - the GNU C++ compiler.
   - Included in GNU Compiler Collection.

 * ld (for GNU/Linux)
   - Download it from http://sources.redhat.com/binutils/
   - the GNU linker.
   - Included in GNU Binutils.

 * Visual C++ 2003 (for Windows)

 * MeCab devel (MeCab版)

 * Anthy devel (Anthy版)

 * Microsoft Platform SDK (for Windows)

 * Cygwin (for Windows)

3. How to compile
=================

First, import SDK environmental variables by following command:

 (for GNU/Linux)
       $ /path/to/ooosdk/setsdkenv_unix
 (for Windows terminal)
       > C:\path\to\OOoSDK\setsdkenv_windows.bat

Then, compile and create an add-on package by following command:

 (for GNU/Linux MeCab)
       $ make -f Makefile.linux
 (for GNU/Linux Anthy)
       $ make -f Makefile.linux anthy
 (for Windows MeCab)
       > make -f Makefile.win32
 (for Windows IMM)
       > make -f Makefile.win32 imm

As a result, furigana-(Version)-(Platform).uno.pkg, furigana-(Version)-Win32-imm.uno.pkg, or furigana-Linux-anthy.uno.pkg should be generated if no error occurs.

4. How to install
=================

4.1 On terminal

Just execute following command:
( Note: You don't have to be root or administrator. )

 (for GNU/Linux MeCab)
      $ make install -f Makefile.linux
 (for GNU/Linux Anthy)
      $ make install-anthy -f Makefile.linux
 (for Windows MeCab)
      > make install -f Makefile.win32
 (for Windows IMM)
      > make install-imm -f Makefile.win32

4.2 From OpenOffice.org

 1. Launch OpenOffice.org

 2. Select "Tools" - "Package Manager" from main menu

 3. Click "Add..." button and open "furigana.uno.pkg"

5. How to use
=============

All functions in this extension take one argument, a string or a single
cell address.
  =FURIGANA("Some Japanese text")
  =ASC(A3)

FURIGANA also accepts a cell range as an argument.
  =FURIGANA(A1:B3)

6. Compatibility problem
========================

This "FURIGANA" function imitates "PHONETIC" function embedded in Microsoft 
Excel, but they sometimes return different results because of the fundamental 
difference of their inner behavior. While the result of "FURIGANA" function 
uses morphological analysis to conversion, "PHONETIC" uses a different way to 
translate Japanese Kana-Kanji mixed text into Katakana string.

On the other hand,"ASC" and "JIS" function are completely compatible with "ASC"
and "JIS" functions embedded in Microsoft Excel.
