Rubyリファレンスマニュアル chm版リミックスをコンパイルするための手順について記載します。 (この手順は、Windows OS上での、Ruby 1.9.3用のリファレンス作成を例にとっています)
分からないことがある場合には、ruby.morphball.net 要望&サポート掲示板までお気軽にご質問ください。 またリファレンスマニュアル刷新計画Webサイトの情報も参考になります。
Subversionを用いて、最新版のリファレンスデータ(doctree)とBitClustを入手し、1つのディレクトリ(以下、REFMTOPとします)の中に配置する。
% cd REFMTOP
% svn co http://jp.rubyist.net/svn/rurema/doctree/trunk doctree
% svn co http://jp.rubyist.net/svn/rurema/bitclust/trunk bitclust
REFMTOP/
- bitclust/
- doctree/
bc-tochm3.rbを bitclust/tools ディレクトリの中に配置する。
REFMTOP/
- bitclust/
- tools/
- bc-tochm.rb
- bc-tochm3.rb
BitClustに対してテンプレート一部デザイン修正パッチを適用する。
% cd bitclust
% patch -p0 < refm-remix-bitclust.patch
% cd ../
BitClust用DBを作成する。(1.9.3となっている箇所は、対象とするRubyのバージョンに合わせて変更してください)
% ruby -I bitclust/lib bitclust/bin/bitclust --database refmdb-1.9.3/ init version=1.9.3 encoding=utf-8
% ruby -I bitclust/lib bitclust/bin/bitclust --database refmdb-1.9.3/ update --stdlibtree=doctree/refm/api/src
% ruby -I bitclust/lib bitclust/bin/bitclust --database refmdb-1.9.3/ --capi update doctree/refm/capi/src/*
bc-tochm3.rb を使って、HTML Help Workshop用のプロジェクトを作成する。
% ruby -E utf-8 bitclust/tools/bc-tochm3.rb --database=refmdb-1.9.3/ --outputdir=refmout-1.9.3/ --version=1.9.3
HTML Help Workshop(hhc.exe)を用いて、プロジェクトを元にchm形式のファイルをコンパイルする。 (この作業はWindows OS上で行う必要があります)
% hhc refmout-1.9.3\refm.hhp
完成! 正常にコンパイルできていれば、refmout-1.9.3 フォルダの中に refm.chm が作成されているはずです。
Rubyリファレンスマニュアル chm版リミックスへの要望、バグ報告、質問などがありましたら、こちらのフォームからお気軽にどうぞ。 また、ruby.morphball.net 要望&サポート掲示板からも受け付けていますので、必要であればそちらもご利用ください。
感想や質問、ご連絡などがあれば、Diceあてに直接メール(tetradice@gmail.com)を飛ばしていただくか、あるいはruby.morphball.net 要望&サポート掲示板からお願いいたします。