ruby.morphball.net > Rubyリファレンスマニュアル chm版リミックス

Rubyリファレンスマニュアル chm版リミックス

chm版リミックスとは?

Ruby公式サイトで配布されている新リファレンスマニュアルを、当サイトが独自にchm形式(HTML Help形式)へコンパイルしたものです。

chm形式のリファレンスマニュアルそのものは、Ruby公式サイトでもすでに配布されておりますが、当サイトで配布しているchm版リミックスには、公式サイトで配布されているものと比較して、以下のような違いがあります。

  1. リファレンスマニュアル刷新計画の最新データを反映している
  2. リファレンスマニュアルのテーマ(表示デザイン)を、標準テーマを含む5種類から選ぶことができる(2013年2月に3種類→5種類へ増加
  3. 表示形式や使い勝手にいくつかの変更を加えている(詳細は公式リファレンスマニュアルとの違いの節を参照してください)

ダウンロード

Rubyリファレンスマニュアル chm版リミックス 2016年11月版 (2016-11-13)
テーマ 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非公式マスコット「るびくる」背景画像(表示サンプルページ)

SourceForge.JP

使い方・注意事項

Windows OSをお使いの方

ダウンロードしたzipファイルを展開して、中に含まれているchmファイルをそのまま開いていただければ、閲覧することができます。

Windows以外のOS(Mac OS X, Linuxなど)をお使いの方

chmを閲覧できるソフトウェアを導入の上、ダウンロードしたzipファイルを展開して、中に含まれているchmファイルを開いてください。 動作確認はとれていませんが、Mac OS XであればiChmCHM Viewなどが使用できるようです。

公式リファレンスマニュアルとの主な違い

当サイトで配布しているリファレンスには、Ruby公式サイトで配布されているchm版の新リファレンスマニュアル(以下、公式版)と比較して、以下のような違いがあります。

1. 標準以外のテーマのリファレンスを配布

リファレンスマニュアルのテーマ(表示デザイン)を、標準テーマを含む5種類から選ぶことができます。

各テーマ比較(クリックでサンプルページを表示します)

white rhythm 2

default(標準)

secondlife blue

secondlife blue + blank

rubicle rhythm 2

2. サイドバーの目次の構成

chm版リミックスでは、「Rubyの起動」「Ruby言語仕様」「sprintf フォーマット」など、組み込みライブラリや添付ライブラリ以外の文書も、左側サイドバーの目次に表示するようにしています。 (全体的に旧リファレンスマニュアルのHTML Help版に近い構成となっています)

公式版
chm版リミックス

3. クラスマニュアル内のメソッド表示形式

クラス(およびモジュール)ページの表示形式が異なります。 公式版では、クラスのページにはメソッドの詳細は表示されず、各メソッドのページへのリンクのみが表示されます。 対して、chm版リミックスでは、クラスのページ1つの中に全メソッドの説明が表示されます(組み込み関数などを除く)。

公式版
chm版リミックス

4. 自動同期

chm版リミックスでは、自動同期オプション(Auto Sync)が有効になっています。 そのため、ページ内のリンクをクリックすると、サイドバーの目次表示もそれに合わせて変化します。

ライセンス

公式リファレンスマニュアルに従い、クリエイティブ・コモンズ 3.0 表示の元で配布します。

クリエイティブ・コモンズ・ライセンス

一言メッセージフォーム

Rubyリファレンスマニュアル chm版リミックスへの要望、バグ報告、質問などがありましたら、こちらのフォームからお気軽にどうぞ。 また、ruby.morphball.net 要望&サポート掲示板からも受け付けていますので、必要であればそちらもご利用ください。

Thanks

Rubyリファレンスマニュアル刷新計画(るりまプロジェクト)
http://bugs.ruby-lang.org/projects/rurema
現在のリファレンスデータは、このプロジェクトによって作成されているため、このプロジェクトの成果がなければchm版リミックスもあり得ませんでした。
RubyリファレンスマニュアルのWindows HTML Help版(青木大輔さん)
http://adai.sakura.ne.jp/old/ruby.html
旧リファレンスマニュアルのHTML Help版です。目次の構成などについて、参考にさせていただきました。また1人のRubyユーザーとしてもたいへんお世話になっています。
RubyのHTML HelpのCSS - coリ・ー・ン<2nd life(secondlifeさん)
http://d.hatena.ne.jp/secondlife/20051023/1129997394
当サイトで「secondlife blue」テーマとして配布しているCSSを、旧リファレンスに組み込んで配布されているページです。 青基調の美しいデザインを見て、以前からこのデザインで新リファレンスを読みたいと(個人的に)思っていました。
wanabeさん
http://bugs.ruby-lang.org/issues/5209
http://bugs.ruby-lang.org/issues/5944
カテゴリ分類パッチやテンプレートの修正パッチを取り込ませていただきました。

ToDo(将来的にやりたいこと)

更新履歴

2015-01-12

chm版リミックスを2015年1月版に更新

2014-07-13

chm版リミックスを2014年7月版に更新

2014-03-16

chm版リミックスを2014年3月版に更新し、Ruby 2.1.0版を追加

2013-11-04

chm版リミックスを2013年11月版に更新

2013-10-02

chm版リミックスを2013年10月版に更新し、Ruby 2.0.0版を追加

2013-02-14

chm版リミックスを2013年2月時点での最新版(revision 5648)に更新し、新しいデザインテーマ「white rhythm 2」と「rubicle rhythm 2」を追加

2012-07-08

chm版リミックスを2012年7月時点での最新版に更新(revision 5259)

2012-05-19

chm版リミックスを更新(revision 5159)し、標準テーマ版以外に新しく「secondlife blue」版と「secondlife blue + blank」版を公開。その他以下の点を更新

2012-05-03

使い方・注意事項の節を追加

2012-05-02

スクリーンショットを掲載

コンパイル手順を公開

2012-04-29

chm版リミックス公開(revision 5145)

連絡先

感想や質問、ご連絡などがあれば、Diceあてに直接メール(tetradice@gmail.com)を飛ばしていただくか、あるいはruby.morphball.net 要望&サポート掲示板からお願いいたします。