Ruby公式サイトで配布されている新リファレンスマニュアルを、当サイトが独自にchm形式(HTML Help形式)へコンパイルしたものです。
chm形式のリファレンスマニュアルそのものは、Ruby公式サイトでもすでに配布されておりますが、当サイトで配布しているchm版リミックスには、公式サイトで配布されているものと比較して、以下のような違いがあります。
テーマ | Ruby 2.3向け | Ruby 2.2向け | Ruby 2.1向け | テーマ概要 |
---|---|---|---|---|
white rhythm 2(推奨) | ダウンロード | ダウンロード | ダウンロード | 白を基調としたモダンな独自デザイン。アイコン表示やRubyコードの色付け表示が特徴 (表示サンプルページ) |
default(標準) | ダウンロード | ダウンロード | ダウンロード | Rubyリファレンスマニュアルの標準デザイン (表示サンプルページ) |
secondlife blue | ダウンロード | ダウンロード | ダウンロード | secondlife氏によって制作された、青を基調としたデザイン (表示サンプルページ) |
secondlife blue + blank | ダウンロード | ダウンロード | ダウンロード | secondlife blueに余白を組み合わせて、配置と読みやすさにこだわったデザイン (表示サンプルページ) |
- | - | - | - | - |
rubicle rhythm 2 | ダウンロード | ダウンロード | ダウンロード | white-rhythm 2 + Ruby非公式マスコット「るびくる」背景画像(表示サンプルページ) |
Ruby 2.0以前向けのリファレンスや、過去のリリースを入手したい場合には、SourceForge.jpのプロジェクトページからお願いいたします。
Rubyリファレンスマニュアル chm版リミックスは、SourceForge.jpの提供するホスティング・サービスを用いて配布されています。
ダウンロードしたzipファイルを展開して、中に含まれているchmファイルをそのまま開いていただければ、閲覧することができます。
chmを閲覧できるソフトウェアを導入の上、ダウンロードしたzipファイルを展開して、中に含まれているchmファイルを開いてください。 動作確認はとれていませんが、Mac OS XであればiChmやCHM Viewなどが使用できるようです。
当サイトで配布しているリファレンスには、Ruby公式サイトで配布されているchm版の新リファレンスマニュアル(以下、公式版)と比較して、以下のような違いがあります。
リファレンスマニュアルのテーマ(表示デザイン)を、標準テーマを含む5種類から選ぶことができます。
chm版リミックスでは、「Rubyの起動」「Ruby言語仕様」「sprintf フォーマット」など、組み込みライブラリや添付ライブラリ以外の文書も、左側サイドバーの目次に表示するようにしています。 (全体的に旧リファレンスマニュアルのHTML Help版に近い構成となっています)
クラス(およびモジュール)ページの表示形式が異なります。 公式版では、クラスのページにはメソッドの詳細は表示されず、各メソッドのページへのリンクのみが表示されます。 対して、chm版リミックスでは、クラスのページ1つの中に全メソッドの説明が表示されます(組み込み関数などを除く)。
chm版リミックスでは、自動同期オプション(Auto Sync)が有効になっています。 そのため、ページ内のリンクをクリックすると、サイドバーの目次表示もそれに合わせて変化します。
公式リファレンスマニュアルに従い、クリエイティブ・コモンズ 3.0 表示の元で配布します。
Rubyリファレンスマニュアル chm版リミックスへの要望、バグ報告、質問などがありましたら、こちらのフォームからお気軽にどうぞ。 また、ruby.morphball.net 要望&サポート掲示板からも受け付けていますので、必要であればそちらもご利用ください。
chm版リミックスを2015年1月版に更新
chm版リミックスを2014年7月版に更新
chm版リミックスを2014年3月版に更新し、Ruby 2.1.0版を追加
chm版リミックスを2013年11月版に更新
chm版リミックスを2013年10月版に更新し、Ruby 2.0.0版を追加
chm版リミックスを2013年2月時点での最新版(revision 5648)に更新し、新しいデザインテーマ「white rhythm 2」と「rubicle rhythm 2」を追加
トップページに、「このリファレンスマニュアルについて」の節と、文書の版・リリース日付の表示を追加し、本ページのURLを明記(Thanks: としやさん)
リファレンスマニュアルを開いたときのウインドウタイトルに「(Remix)」という文字列を追加
chm版リミックスを2012年7月時点での最新版に更新(revision 5259)
String#pathmap
など、「外部ライブラリで再定義されるメソッド」が表示できない不具合を修正
ファイルサイズの削減処理は、弊害が大きいため中止し、元のように全てのメソッドごとのHTMLページをchmに含めるようにした(5MB→9MB)
chm版リミックスを更新(revision 5159)し、標準テーマ版以外に新しく「secondlife blue」版と「secondlife blue + blank」版を公開。その他以下の点を更新
Windowsでchmを直接ダウンロードすると、セキュリティの問題でchmの中身を表示できないことがあるため、zip形式に圧縮して配布するように変更
メソッドごとのHTMLページをchmに含めないようにして、サイズを大幅に軽量化(およそ9MB→5MB)
通常の文書ページで、パンくずリストに文書のタイトルを表示するようにした(今まではファイル名を表示していた)
使い方・注意事項の節を追加
スクリーンショットを掲載
コンパイル手順を公開
chm版リミックス公開(revision 5145)
感想や質問、ご連絡などがあれば、Diceあてに直接メール(tetradice@gmail.com)を飛ばしていただくか、あるいはruby.morphball.net 要望&サポート掲示板からお願いいたします。