ruby-refe.l

Last modified: "2010/04/03 01:04:44"

Description

ruby-refe

HATTORI Masashi さんの ruby-mode から,ReFe2 を参照します。

ruby-mode
http://www7a.biglobe.ne.jp/~hat/xyzzy/ruby-mode.html

Rubyリファレンスマニュアル刷新計画
http://redmine.ruby-lang.org/wiki/rurema/ReleasedProducts

Download ...

Install

1. ruby-refe.l を site-lisp にコピーする。

2. 必要に応じ,バイトコンパイルする。(任意)

  M-x byte-compile-file

3. Rubyリファレンスマニュアルパッケージ版を入手し,展開する。 c:/rubyrefm に展開する場合は,こんな感じ。

  c:/rubyrefm/
   ├ bitclust/
   │ ├ bin/
   │ │ └ refe.rb
   │ └ lib/
   ├ db-1_8_7/
   └ db-1_9_1/

※Rubyリファレンスマニュアルを c:/rubyrefm/ 以外にインストール する場合は,設定例に従い,*ruby-refe-install-path* を設定する 必要があります。

4. .xyzzy か siteinit.l に以下の記述を追加する。

  (require "ruby-refe")

NetInstaller からインストールして、自動設定機能を利用している場合は、 「 3. Rubyリファレンスマニュアルパッケージ版の入手&展開」のみを行ってください。 (siteinit.l に自動設定機能の記述をしている場合は、ダンプファイルを作成しなおしてください)。

Usage

M-x ruby-refe して,検索するシンボルとオプションを指定します。 オプションに --help を指定すると,オプション一覧が表示されます。

実行例は,ReFe: http://i.loveruby.net/ja/prog/refe.html あたりを参照してください。(旧版の紹介ページです。ReFe2 になってオプションが変わっています。)

「Setting」の内容でキーバインドの設定を行い ruby-mode で F1 を押下すると, カーソル位置の単語を含むシンボルの一覧が表示されます。 一覧の中から参照したいシンボルにカーソルを合わせて Enter を押下すると, リファレンスが参照できます。

リファレンスバッファでは,以下のコマンドが使用できます。

    RET   : カーソル位置のシンボルを引く
    F1    : カーソル位置のシンボルを引く (一覧表示)
    r     : refe 実行
    l     : refe -l 実行
    o     : 次のウィンドウに移動
    q     : 終了

Setting

  F1 キーで,カーソル位置の単語を ReFe から引く。

    (define-key *ruby-mode-map* #\F1 'ruby-refe-line-point)

  ReFe コマンドのエイリアス。M-x refe で実行するように。

    (setf (symbol-function 'refe) #'ruby-refe)

  ReFe のインストールパスを変更。(既定値は "c:/rubyrefm")

    (setq *ruby-refe-install-path* "d:/opt/rubyrefm")

  Ruby ReFe のデータベース名を指定。(既定値は "db-1_8_7")

      (setq *ruby-refe-dbname* "db-1_9_1")

History

  [Version 2.00] 2010-04-01 (木)
  ・ReFe2 に対応した(はず)。
  ・ReFe1 非対応にした。
  ・オプションが指定できるようにした。
  ・その他いろいろ。

  [Version 1.00] 2008-01-06 (日)
  ・初版作成。

License

  ruby-refe.l はMITライセンスに基づいて利用可能です。
  

Copyright (c) 2007-2010 HIE Masahiro

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.

(^_^)