update.
[chise/ruby.git] / doc / index.html
index 72ac3bd..e69de29 100755 (executable)
@@ -1,327 +0,0 @@
-<html>
-<head>
-<title>Ruby/CHISE</title>
-<link rel="stylesheet" type="text/css" href="style.css">
-</head>
-
-<body>
-<div class="center">
-
-<h1><span class="e">Ruby/CHISE</span></h1>
-
-<div class=linkbox>
-<a href="#download">download</a>,
-<a href="#install">install</a>,
-<a href="#howto">howto</a>,
-<a href="#links">links</a>
-</div>
-
-<div class="w40em">
-
-<div class=box>
-<h2>■<span class="e">Ruby/CHISE</span>とはなにか</h2>
-<p>Ruby/CHISEは、XEmacs CHISEにおけるChaon実装を<br>
-Rubyへ移植することを試みたモジュールである。<br>
-
-<h3>■Chaonモデルとはなにか</h3>
-
-<p>Chaonモデルとは、文字を符号ではなく属性によって扱う方法を意味する。
-<p>Ruby/CHISEではそれを拡張し、文字をオブジェクトとして扱っている。
-
-</div>
-
-<div class=box>
-<a name="download"></a>
-<h2 class="e">■download & history</h2>
-<ul>
-<li>2003-0110  テスト公開
-<li>2003-0112  XString追加
-<li>2003-0115  IDSの読み込み機能β版
-<li>2003-0116  IDSの読み込み機能1.0
-<li>2003-0117  XStringを廃止し、Stringに一本化。IDSの読み込み機能を強化。
-<li>2003-0120  IDS_Treeの読み込み機能を追加。木構造の整合性checkを追加。
-<li>2003-0130  IDSの逆変換機能などを追加。
-<li>2003-0213  <a href="http://eto.com/2003/ruby/ruby-chise-20030213.tar.bz2" class="s">ruby-chise-20030213.tar.bz2</a><br>
-名称をRuby/UTF-2000からRuby/CHISEへと変更。
-<li>2003-0312  <a href="http://eto.com/2003/ruby/ruby-chise-20030312.tar.bz2" class="s">ruby-chise-20030312.tar.bz2</a><br>
-様々なライブラリを追加。
-<li>2003-1004  <a href="http://eto.com/2003/ruby/ruby-chise-20031004.tar.bz2" class="s">ruby-chise-20031004.tar.bz2</a><br>
-新しい素性名に対応した。Copyright noticeをいれた。
-<li>2003-10-31 <a href="http://lc.linux.or.jp/lc2003/">LC2003</a>にて発表。
-<li>2003-1110  <a href="http://eto.com/2003/ruby/ruby-chise-20031110.tar.bz2" class="s">ruby-chise-20031110.tar.bz2</a><br>
-ディレクトリ構造をchise/*.rbとなるように変更。installerをつけた。
-</ul>
-<hr>
-
-<h3>■文字データベース</h3>
-<p>現状での文字DBを公開する。0.21が出る直前のCVS版を元にしている。
-<ul>
-<li>2003-11-04 <a href="http://eto.com/2003/ruby/char-db.tar.gz" class="s">char-db.tar.gz</a> Windows用<br>
-LinuxでXEmacs CHISEをinstallし、付属のmkdbtarball.rbを使った作成した.tar.gzにしたもの。
-<li>2003-11-04 <a href="http://eto.com/2003/ruby/char-db-linux.tar.bz2" class="s">char-db-linux.tar.bz2</a> Linux用<br>
-/usr/local/lib/xemacs-21.4.12/i686-pc-linux/char-db以下をtar.bz2にしたもの。
-</ul>
-
-<hr>
-<h3>■<a href="http://cvs.m17n.org/cgi-bin/viewcvs/ruby/?cvsroot=chise">CVS access</a></h3>
-<hr>
-<h3>■ライセンス</h3>
-<p>GPLです。COPYINGをごらんください。</p>
-<p>
-</div>
-
-<div class=box>
-<a name="install"></a>
-<h2 class="e">■install</h2>
-<pre>
-% ruby install.rb config
-% ruby install.rb setup
-# ruby install.rb install
-</pre>
-<p>通常、<b>/usr/local/lib/ruby/site_ruby/</b>以下にinstallされる。
-
-<hr>
-<h3 class="e">■config</h3>
-<p><b>src/chise.rb</b>内
-<p><b>DB_DIR = '/usr/local/lib/xemacs-21.4.10/i686-pc-linux/char-db'</b><br>
-必要に応じて変更する。
-<p><b>IDS_DB_DIR = '/home/eto/work/chise/ids/''</b><br>
-IDSのテキストファイルが置かれているディレクトリーを指す。(下記の字形分解・合成についてを参照)
-
-<hr>
-<h3 class="e">■依存関係</h3>
-<p>下記のパッケージが必要。
-<ul>
-<li><a href="http://www.sleepycat.com/" class="b">db3-3.2.9</a>
-<li><a href="http://www.ruby-lang.org/~eban/ruby/binaries/mingw/ext/" class="b">bdb-0.3.6</a> (bdb-0.3.8などそれ以上でも可)
-<li><a href="http://www.yoshidam.net/Ruby_ja.html#uconv" class="b">uconv-0.4.11</a>
-<li><a href="http://www.ruby-lang.org/ja/" class="b">ruby 1.6.7</a> これはRuby本体。
-</ul>  
-
-<p>一般にRubyのパッケージは
-<a href="http://www.ruby-lang.org/raa/"><b>RAA</b></a>を使って探すことができる。
-
-<hr>
-<h3 class="e">■Unicode</h3>
-<p>現状では、Ruby/CHISEに渡す文字コードはUTF-8のUnicodeにしておくと便利である。
-<p>将来的にはプログラム自体がSJIS、EUCなどで書かれていても
-問題なく処理できるようにしたい。
-<p>WindowsでUnicodeを使えるエディターとして、Meadow + Mule-UCSが使える。
-<p>フリーのUnicode対応エディターとして「<a href="http://members.tripod.co.jp/sakura_editor/">サクラエディタ</a>」が使える。
-<p>他、Windows付属のメモ帳、見るだけであればIEが使える。
-</div>
-
-<div class=box>
-<h2>■付属libraryの説明</h2>
-<p>現時点では個々の詳細には立ち入りません。
-
-<ul>
-
-<li>ext/*<br>
-libchiseを用いたextensionです。現在はプレアルファ版です。
-
-<li>network.rb, makegraph.rb, graphviz.rb, defkanji.rb, kanjilist.rb<br>
-漢字の部品間の接続関係を計算します。Graphvizによるグラフ化も行います。
-<pre>
-ruby makegraph.rb
-</pre>
-<p>Graphvizが必要です。min.svgが生成されます。
-
-<pre>
-ruby defkanji.rb
-</pre>
-<p>漢字の定義を行います。
-
-<li>stroke.rb, kage.rb, kageserver.rb, csf.rb<br>
-StrokeFontを用いるライブラリー群。
-上地宏一氏によるKAGE System(現時点ではまだ非公開), 坂直純氏によるCSFという二つのStrokeFontが使えます。
-別途フォントファイルが必要です。<br>
-<tt>csf.rb</tt>中の<tt>CSF_FONT_DIR = 'd:/work/chise/csf/'</tt>を適切に設定してください。
-<p>sglという独自のグラフィックライブラリーが必要ですが、これはまだ非公開です。
-
-<pre>
-ruby stroke.rb
-</pre>
-<p>漢字のCodeTableが表れ、その中の文字を表示できます。
-
-<ul>
-<li><a href="http://www.fonts.jp/">漢字フォント自動生成技術フォーラム</a>
-<li><a href="http://web.sfc.keio.ac.jp/~kamichi/kage/kage.html">KAGEモデル</a>
-<li><a href="http://www.vector.co.jp/soft/win95/writing/se256880.html">KST32ZX</a>, 篆文風(Zhuanwen-Like),漢字StrokeFont(KST)
-<li><a href="http://www.vector.co.jp/soft/data/writing/se119277.html">KST32A</a>, 極めてコンパクトなJIS第一水準漢字(非漢字)ストローク・テーブル
-</ul>
-
-</ul>
-</div>
-
-<div class=box>
-<a name="howto"></a>
-<h2>■使い方</h2>
-<p>
-
-<h3>■全体的な使い方</h3>
-<pre>
-require 'chise'
-include CHISE
-
-str = "字" #Stringを拡張している。UTF8で与えること。
-p str.ucs #とすると、その文字のucsの値が表示される
-p str.total_strokes #画数が表示される
-p str.gb2312 #などなど
-str.char.alist.each {|a, v| #こんな感じで全属性を表示できる
-  print a, ': ', v, "\n"
-}
-p str.inspect_x #Characterについての情報が表示される。
-p str.inspect_all #持っている属性情報を全て表示する。
-
-str = "文字列" #もちろん一文字でなく文字列も扱える。UTF-8で与える。
-p str.inspect_x #各文字の情報が表示される。
-p str.inspect_all #各文字の属性情報を全て表示する。
-</pre>
-
-</div>
-
-<div class=box>
-<h2>■字形分解・合成</h2>
-<p>Ruby/CHISEは、もともと字形分解・合成を扱うために作られたため、その機能が強化されている。
-
-<p>字形分解・合成は、現在はUnicodeにおけるIDS(Ideographic Description Structure)という仕様に準拠している。
-U+2FF0〜U+2FFBで表わされるIDC(Ideographic Description Characters)によって合成方法を指定し、
-これに続く二文字から三文字の文字を合成して表示する。
-
-<hr>
-<h3 class="e">■IDSを使うための準備</h3>
-
-<p>下記のようにして、IDSのテキストファイル群を持ってくる。
-<pre><small>% cd ~/work/chise (このディレクトリーは適宜変更する)
-% cvs -d :pserver:anonymous@cvs.m17n.org:/cvs/root login
-password: (何も入れずにただもう一度return)
-
-% cvs -d :pserver:anonymous@cvs.m17n.org:/cvs/chise co -d ids ids
-</small></pre>
-
-<p>このようにすると、IDSのテキストファイル群を持ってくることができる。
-
-<p>その後、<b>src/chise.rb</b>内<br>
-<b>IDS_DB_DIR = '/home/eto/work/chise/ids/''</b><br>
-ここに、上記のIDSテキストファイル群を持ってきたディレクトリーを入れる。
-必要であれば、再度<b>make install</b>する。
-このようにして適切に<b>IDS_DB_DIR</b>を設定し、
-<b>./tools/idsdbdumpall.rb</b>を実行する。(かなり時間がかかる)
-これで、文字属性として新たにids, ids-decomposeが加わった。
-それぞれ、IDSの文字列、それを再帰的に分解しきったものを意味する。
-
-<hr>
-<h3 class="e">■字形分解</h3>
-<p>Stringに、decompose, decompose_allという二つのメソッドがある。
-decomposeは一段階だけ分解する。decompose_allはそれを再帰的に行う。
-<pre>
-p "字".decompose
-p "字".decompose_all
-p "榊".decompose
-p "榊".decompose_all
-p "終了".decompose
-p "終了".decompose_all
-p "鬱".decompose
-p "鬱".decompose_all
-</pre>
-
-<p>最初の説明から、字形分解されて出てきた結果の文字列には、
-IDSキャラクターが含まれているため、場合によってはうまく表示されない。
-メモ帳だと表示できるだろう。
-
-<hr>
-<h3 class="e">■字形合成</h3>
-<p>字形合成は、composeメソッドで行う。
-<pre>
-p "&#x2ff0;木木".compose
-</pre>
-
-<p>findメソッドで、ある部品が漢字の一部として含まれている漢字群を探すことができる。
-<pre>
-p "日雲".find
-</pre>
-<p>ここでは、日と雲という部品が含まれている全漢字を出力する。
-
-</div>
-
-<div class=box>
-<h2>■説明</h2>
-<p>まじめなメソッドの説明を書く。(未完)
-<p>現時点では、test caseを見たほうが使い方はわかりやすいかもしれません。
-<pre>
-class String
-       char    先頭の文字をCharacterに変換したものを返す
-→method_missingで、存在しないmethodを指定すると、自動的に先頭の文字を
-Characterに変換してそれへのmethodとして呼ぶ。
-
-class Character
-       get     ある文字をgetする。(flyweightパターン)
-       []      ある属性をgetする。get_char_attributeも使える。
-               またmethod_missingも使える。
-       []=     ある属性をputする。put_char_attributeも使える。
-               またmethod_missingによる入力も使える。
-存在しない属性を参照したときは、nilが返る。
-</pre>
-
-<hr>
-<h3>■tools</h3>
-<p>詳しくは<b>tools/README</b>を参照。
-<ul>
-<li><b>dbdumpall.rb</b>, char-dbのBDBファイル群の中身をテキストとして展開する。
-<li><b>idsdumpall.rb</b>, IDSのテキストファイル群を読みこみ、BDB化する。再帰的に展開したids-decomposeも作る。
-<li><b>idscheckintegrity.rb</b>, IDSの木構造の整合性をチェックする。
-<li><b>mkdbtarball.rb</b>, UNIXで作ったBDBファイル群をWindowsに持っていくときに使う。
-Windowsでtar.gzを展開するには、<a href="http://member.nifty.ne.jp/beambitious/">eo</a>がおすすめ。
-<li>trim_bom.rb, Unicodeファイルを作ったときの先頭についてくるBOM(byte order mark)を削除する。
-</ul>
-</div>
-
-<div class=box>
-<h2>■悩みどころ</h2>
-<p>
-<h3 class="e">■Ruby/M17Nとの整合性</h3>
-<p>Ruby/M17Nとの整合性をどうとればいいか。
-<ul>
-<li><a href="http://www.inac.co.jp/~maki/ruby/ruby-i18n.html">M17N/I18N for Ruby</a>
-<li><a href="http://www.inac.co.jp/~maki/ruby/matz-000516.html">Matz によるI18Nに関するコメント(2000/05/16) </a>
-<li><a href="http://ns1.php.gr.jp/pipermail/php-dev/2002-April/000274.html">高橋征義氏による、Ruby M17Nの解説</a>
-<li><a href="http://cvs.ruby-lang.org/~knu/cgi-bin/cvsweb.cgi/ruby/?only_with_tag=ruby_m17n">Ruby/M17N</a>
-</ul>
-
-<p>Ruby/M17Nブランチが本体に反映されるのは、ruby-1.8以降が予定されている。
-
-<p>ソースコード中のm17n.c, m17n.hが該当個所。
-内部的にはUTF-8として扱えるので、それを拡張すればいいか?
-UTF-8の処理への追加という形で実装できる?
-
-</div>
-
-<div class=box>
-<a name="links"></a>
-<h2 class="e">■links</h2>
-<p>
-<h3 class="e">■CHISE project</h3>
-<ul>
-<li><a href="http://cvs.m17n.org/chise/">CHISE project</a>
-(<a href="http://www.kanji.zinbun.kyoto-u.ac.jp/projects/chise/">kyoto-u</a>,
-<a href="http://mousai.as.wakwak.ne.jp/projects/chise/">mousai</a>)
-<li><a href="http://cvs.m17n.org/chise/ruby/index.html.ja.iso-2022-jp">Ruby/CHISE page at CHISE project</a>
-<li><a href="http://cvs.m17n.org/cgi-bin/viewcvs/perl/?cvsroot=chise">師茂樹氏 Perl/CHISE → CHISE.pm</a>
-</ul>
-
-<h3 class="e">■Ruby</h3>
-<ul>
-<li><a href="http://www.ruby-lang.org/ja/">Ruby</a>
-<li><a href="http://blade.nagaokaut.ac.jp/cgi-bin/scat.rb/ruby/ruby-dev/11450">akr氏によるRuby/CHISE仕様案</a>
-<li><a href="http://moulon.inra.fr/ruby/bdb.html">Ruby/BDB</a>
-<li><a href="http://www.ruby-lang.org/~eban/ruby/binaries/mingw/ext/">eban氏によるコンパイル済みの拡張ライブラリー</a>
-</ul>
-</div>
-
-</div>
-
-<address><a href="http://eto.com/"><span class="white">Kouichirou Eto</span></a>, 2003 at eto.com</address>
-
-</body>
-</html>