doc/index.html

   1 <html>
   2 <head>
   3 <title>Ruby/CHISE</title>
   4 <link rel="stylesheet" type="text/css" href="style.css">
   5 </head>
   6
   7 <body>
   8 <div class="center">
   9
  10 <h1><span class="e">Ruby/CHISE</span></h1>
  11
  12 <div class=linkbox>
  13 <a href="#download">download</a>,
  14 <a href="#install">install</a>,
  15 <a href="#howto">howto</a>,
  16 <a href="#links">links</a>
  17 </div>
  18
  19 <div class="w40em">
  20
  21 <div class=box>
  22 <h2>■<span class="e">Ruby/CHISE</span>とはなにか</h2>
  23 <p>Ruby/CHISEは、XEmacs CHISEにおけるChaon実装を<br>
  24 Rubyへ移植することを試みたモジュールである。<br>
  25
  26 <h3>■Chaonモデルとはなにか</h3>
  27
  28 <p>Chaonモデルとは、文字を符号ではなく属性によって扱う方法を意味する。
  29 <p>Ruby/CHISEではそれを拡張し、文字をオブジェクトとして扱っている。
  30
  31 </div>
  32
  33 <div class=box>
  34 <a name="download"></a>
  35 <h2 class="e">■download & history</h2>
  36 <ul>
  37 <li>2003-0110   テスト公開
  38 <li>2003-0112   XString追加
  39 <li>2003-0115   IDSの読み込み機能β版
  40 <li>2003-0116   IDSの読み込み機能1.0
  41 <li>2003-0117   XStringを廃止し、Stringに一本化。IDSの読み込み機能を強化。
  42 <li>2003-0120   IDS_Treeの読み込み機能を追加。木構造の整合性checkを追加。
  43 <li>2003-0130   IDSの逆変換機能などを追加。
  44 <li>2003-0213   <a href="http://eto.com/2003/ruby/ruby-chise-20030213.tar.bz2" class="s">ruby-chise-20030213.tar.bz2</a><br>
  45 名称をRuby/UTF-2000からRuby/CHISEへと変更。
  46 <li>2003-0312   <a href="http://eto.com/2003/ruby/ruby-chise-20030312.tar.bz2" class="s">ruby-chise-20030312.tar.bz2</a><br>
  47 様々なライブラリを追加。
  48 </ul>
  49 <hr>
  50 <h3>■<a href="http://cvs.m17n.org/cgi-bin/viewcvs/ruby/?cvsroot=chise">CVS access</a></h3>
  51 <p>
  52 </div>
  53
  54 <div class=box>
  55 <a name="install"></a>
  56 <h2 class="e">■install</h2>
  57 <p>展開して、<b>make install</b>する。
  58 <p>通常、<b>/usr/local/lib/ruby/site_ruby/</b>以下にinstallされる。
  59
  60 <hr>
  61 <h3 class="e">■config</h3>
  62 <p><b>src/chise.rb</b>内
  63 <p><b>DB_DIR = '/usr/local/lib/xemacs-21.4.10/i686-pc-linux/char-db'</b><br>
  64 必要に応じて変更する。
  65 <p><b>IDS_DB_DIR = '/home/eto/work/chise/ids/''</b><br>
  66 IDSのテキストファイルが置かれているディレクトリーを指す。(下記の字形分解・合成についてを参照)
  67
  68 <hr>
  69 <h3 class="e">■依存関係</h3>
  70 <p>下記のパッケージが必要。
  71 <ul>
  72 <li><a href="http://www.sleepycat.com/" class="b">db3-3.2.9</a>
  73 <li><a href="http://www.ruby-lang.org/~eban/ruby/binaries/mingw/ext/" class="b">bdb-0.3.6</a> (bdb-0.3.8などそれ以上でも可)
  74 <li><a href="http://www.yoshidam.net/Ruby_ja.html#uconv" class="b">uconv-0.4.11</a>
  75 <li><a href="http://www.ruby-lang.org/ja/" class="b">ruby 1.6.7</a> これはRuby本体。
  76 </ul>
  77
  78 <p>一般にRubyのパッケージは
  79 <a href="http://www.ruby-lang.org/raa/"><b>RAA</b></a>を使って探すことができる。
  80
  81 <hr>
  82 <h3 class="e">■Unicode</h3>
  83 <p>現状では、Ruby/CHISEに渡す文字コードはUTF-8のUnicodeにしておくと便利である。
  84 <p>将来的にはプログラム自体がSJIS、EUCなどで書かれていても
  85 問題なく処理できるようにしたい。
  86 <p>WindowsでUnicodeを使えるエディターとして、Meadow + Mule-UCSが使える。
  87 <p>フリーのUnicode対応エディターとして「<a href="http://members.tripod.co.jp/sakura_editor/">サクラエディタ</a>」が使える。
  88 <p>他、Windows付属のメモ帳、見るだけであればIEが使える。
  89 </div>
  90
  91 <div class=box>
  92 <h2>■付属libraryの説明</h2>
  93 <p>現時点では個々の詳細には立ち入りません。
  94
  95 <ul>
  96
  97 <li>ext/*<br>
  98 libchiseを用いたextensionです。現在はプレアルファ版です。
  99
 100 <li>network.rb, makegraph.rb, graphviz.rb, defkanji.rb, kanjilist.rb<br>
 101 漢字の部品間の接続関係を計算します。Graphvizによるグラフ化も行います。
 102 <pre>
 103 ruby makegraph.rb
 104 </pre>
 105 <p>Graphvizが必要です。min.svgが生成されます。
 106
 107 <pre>
 108 ruby defkanji.rb
 109 </pre>
 110 <p>漢字の定義を行います。
 111
 112 <li>stroke.rb, kage.rb, kageserver.rb, csf.rb<br>
 113 StrokeFontを用いるライブラリー群。
 114 上地宏一氏によるKAGE System(現時点ではまだ非公開), 坂直純氏によるCSFという二つのStrokeFontが使えます。
 115 別途フォントファイルが必要です。<br>
 116 <tt>csf.rb</tt>中の<tt>CSF_FONT_DIR = 'd:/work/chise/csf/'</tt>を適切に設定してください。
 117 <p>sglという独自のグラフィックライブラリーが必要ですが、これはまだ非公開です。
 118
 119 <pre>
 120 ruby stroke.rb
 121 </pre>
 122 <p>漢字のCodeTableが表れ、その中の文字を表示できます。
 123
 124 <ul>
 125 <li><a href="http://www.fonts.jp/">漢字フォント自動生成技術フォーラム</a>
 126 <li><a href="http://web.sfc.keio.ac.jp/~kamichi/kage/kage.html">KAGEモデル</a>
 127 <li><a href="http://www.vector.co.jp/soft/win95/writing/se256880.html">KST32ZX</a>, 篆文風(Zhuanwen-Like),漢字StrokeFont(KST)
 128 <li><a href="http://www.vector.co.jp/soft/data/writing/se119277.html">KST32A</a>, 極めてコンパクトなJIS第一水準漢字(非漢字)ストローク・テーブル
 129 </ul>
 130
 131 </ul>
 132 </div>
 133
 134 <div class=box>
 135 <a name="howto"></a>
 136 <h2>■使い方</h2>
 137 <p>
 138
 139 <h3>■全体的な使い方</h3>
 140 <pre>
 141 require 'chise'
 142 include CHISE
 143
 144 str = "字" #Stringを拡張している。UTF8で与えること。
 145 p str.ucs #とすると、その文字のucsの値が表示される
 146 p str.total_strokes #画数が表示される
 147 p str.chinese_gb2312 #などなど
 148 str.char.alist.each {|a, v| #こんな感じで全属性を表示できる
 149   print a, ': ', v, "\n"
 150 }
 151 p str.inspect_x #Characterについての情報が表示される。
 152 p str.inspect_all #持っている属性情報を全て表示する。
 153
 154 str = "文字列" #もちろん一文字でなく文字列も扱える。UTF-8で与える。
 155 p str.inspect_x #各文字の情報が表示される。
 156 p str.inspect_all #各文字の属性情報を全て表示する。
 157 </pre>
 158
 159 </div>
 160
 161 <div class=box>
 162 <h2>■字形分解・合成</h2>
 163 <p>Ruby/CHISEは、もともと字形分解・合成を扱うために作られたため、その機能が強化されている。
 164
 165 <p>字形分解・合成は、現在はUnicodeにおけるIDS(Ideographic Description Structure)という仕様に準拠している。
 166 U+2FF0〜U+2FFBで表わされるIDC(Ideographic Description Characters)によって合成方法を指定し、
 167 これに続く二文字から三文字の文字を合成して表示する。
 168
 169 <hr>
 170 <h3 class="e">■IDSを使うための準備</h3>
 171
 172 <p>下記のようにして、IDSのテキストファイル群を持ってくる。
 173 <pre><small>% cd ~/work/chise (このディレクトリーは適宜変更する)
 174 % cvs -d :pserver:anonymous@cvs.m17n.org:/cvs/root login
 175 password: (何も入れずにただもう一度return)
 176
 177 % cvs -d :pserver:anonymous@cvs.m17n.org:/cvs/chise co -d ids ids
 178 </small></pre>
 179
 180 <p>このようにすると、IDSのテキストファイル群を持ってくることができる。
 181
 182 <p>その後、<b>src/chise.rb</b>内<br>
 183 <b>IDS_DB_DIR = '/home/eto/work/chise/ids/''</b><br>
 184 ここに、上記のIDSテキストファイル群を持ってきたディレクトリーを入れる。
 185 必要であれば、再度<b>make install</b>する。
 186 このようにして適切に<b>IDS_DB_DIR</b>を設定し、
 187 <b>./tools/idsdbdumpall.rb</b>を実行する。(かなり時間がかかる)
 188 これで、文字属性として新たにids, ids-decomposeが加わった。
 189 それぞれ、IDSの文字列、それを再帰的に分解しきったものを意味する。
 190
 191 <hr>
 192 <h3 class="e">■字形分解</h3>
 193 <p>Stringに、decompose, decompose_allという二つのメソッドがある。
 194 decomposeは一段階だけ分解する。decompose_allはそれを再帰的に行う。
 195 <pre>
 196 p "字".decompose
 197 p "字".decompose_all
 198 p "榊".decompose
 199 p "榊".decompose_all
 200 p "終了".decompose
 201 p "終了".decompose_all
 202 p "鬱".decompose
 203 p "鬱".decompose_all
 204 </pre>
 205
 206 <p>最初の説明から、字形分解されて出てきた結果の文字列には、
 207 IDSキャラクターが含まれているため、場合によってはうまく表示されない。
 208 メモ帳だと表示できるだろう。
 209
 210 <hr>
 211 <h3 class="e">■字形合成</h3>
 212 <p>字形合成は、composeメソッドで行う。
 213 <pre>
 214 p "&#x2ff0;木木".compose
 215 </pre>
 216
 217 <p>findメソッドで、ある部品が漢字の一部として含まれている漢字群を探すことができる。
 218 <pre>
 219 p "日雲".find
 220 </pre>
 221 <p>ここでは、日と雲という部品が含まれている全漢字を出力する。
 222
 223 </div>
 224
 225 <div class=box>
 226 <h2>■説明</h2>
 227 <p>まじめなメソッドの説明を書く。(未完)
 228 <p>現時点では、test caseを見たほうが使い方はわかりやすいかもしれません。
 229 <pre>
 230 class String
 231         char    先頭の文字をCharacterに変換したものを返す
 232 →method_missingで、存在しないmethodを指定すると、自動的に先頭の文字を
 233 Characterに変換してそれへのmethodとして呼ぶ。
 234
 235 class Character
 236         get     ある文字をgetする。(flyweightパターン)
 237         []      ある属性をgetする。get_char_attributeも使える。
 238                 またmethod_missingも使える。
 239         []=     ある属性をputする。put_char_attributeも使える。
 240                 またmethod_missingによる入力も使える。
 241 存在しない属性を参照したときは、nilが返る。
 242 </pre>
 243
 244 <hr>
 245 <h3>■tools</h3>
 246 <p>詳しくは<b>tools/README</b>を参照。
 247 <ul>
 248 <li><b>dbdumpall.rb</b>, char-dbのBDBファイル群の中身をテキストとして展開する。
 249 <li><b>idsdumpall.rb</b>, IDSのテキストファイル群を読みこみ、BDB化する。再帰的に展開したids-decomposeも作る。
 250 <li><b>idscheckintegrity.rb</b>, IDSの木構造の整合性をチェックする。
 251 <li><b>mkdbtarball.rb</b>, UNIXで作ったBDBファイル群をWindowsに持っていくときに使う。
 252 Windowsでtar.gzを展開するには、<a href="http://member.nifty.ne.jp/beambitious/">eo</a>がおすすめ。
 253 <li>trim_bom.rb, Unicodeファイルを作ったときの先頭についてくるBOM(byte order mark)を削除する。
 254 </ul>
 255 </div>
 256
 257 <div class=box>
 258 <h2>■悩みどころ</h2>
 259 <p>
 260 <h3 class="e">■Ruby/M17Nとの整合性</h3>
 261 <p>Ruby/M17Nとの整合性をどうとればいいか。
 262 <ul>
 263 <li><a href="http://www.inac.co.jp/~maki/ruby/ruby-i18n.html">M17N/I18N for Ruby</a>
 264 <li><a href="http://www.inac.co.jp/~maki/ruby/matz-000516.html">Matz によるI18Nに関するコメント(2000/05/16) </a>
 265 <li><a href="http://ns1.php.gr.jp/pipermail/php-dev/2002-April/000274.html">高橋征義氏による、Ruby M17Nの解説</a>
 266 <li><a href="http://cvs.ruby-lang.org/~knu/cgi-bin/cvsweb.cgi/ruby/?only_with_tag=ruby_m17n">Ruby/M17N</a>
 267 </ul>
 268
 269 <p>Ruby/M17Nブランチが本体に反映されるのは、ruby-1.8以降が予定されている。
 270
 271 <p>ソースコード中のm17n.c, m17n.hが該当個所。
 272 内部的にはUTF-8として扱えるので、それを拡張すればいいか?
 273 UTF-8の処理への追加という形で実装できる?
 274
 275 </div>
 276
 277 <div class=box>
 278 <a name="links"></a>
 279 <h2 class="e">■links</h2>
 280 <p>
 281 <h3 class="e">■CHISE project</h3>
 282 <ul>
 283 <li><a href="http://cvs.m17n.org/chise/">CHISE project</a>
 284 (<a href="http://www.kanji.zinbun.kyoto-u.ac.jp/projects/chise/">kyoto-u</a>,
 285 <a href="http://mousai.as.wakwak.ne.jp/projects/chise/">mousai</a>)
 286 <li><a href="http://cvs.m17n.org/chise/ruby/index.html.ja.iso-2022-jp">Ruby/CHISE page at CHISE project</a>
 287 <li><a href="http://cvs.m17n.org/cgi-bin/viewcvs/perl/?cvsroot=chise">師茂樹氏 Perl/CHISE → CHISE.pm</a>
 288 </ul>
 289
 290 <h3 class="e">■Ruby</h3>
 291 <ul>
 292 <li><a href="http://www.ruby-lang.org/ja/">Ruby</a>
 293 <li><a href="http://blade.nagaokaut.ac.jp/cgi-bin/scat.rb/ruby/ruby-dev/11450">akr氏によるRuby/CHISE仕様案</a>
 294 <li><a href="http://moulon.inra.fr/ruby/bdb.html">Ruby/BDB</a>
 295 <li><a href="http://www.ruby-lang.org/~eban/ruby/binaries/mingw/ext/">eban氏によるコンパイル済みの拡張ライブラリー</a>
 296 </ul>
 297 </div>
 298
 299 </div>
 300
 301 <address><a href="http://eto.com/"><span class="white">Kouichirou Eto</span></a>, 2003 at eto.com</address>
 302
 303 </body>
 304 </html>